Use this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time in unhealthy periods that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
" + "documentation":"Use this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
" }, "CreateServiceLevelObjective":{ "name":"CreateServiceLevelObjective", @@ -44,7 +44,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"} ], - "documentation":"Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
When you create an SLO, you set an attainment goal for it. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the number of periods or amount of time that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. for example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
When you call this operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
For more information about SLOs, see Service level objectives (SLOs).
" + "documentation":"Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
The target performance quality that is defined for an SLO is the attainment goal.
You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.
For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.
For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
For more information about SLOs, see Service level objectives (SLOs).
When you perform a CreateServiceLevelObjective operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
" + "documentation":"Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.
" } }, "shapes":{ @@ -334,6 +334,10 @@ } } }, + "BudgetRequestsRemaining":{ + "type":"integer", + "box":true + }, "BudgetSecondsRemaining":{ "type":"integer", "box":true @@ -381,10 +385,7 @@ }, "CreateServiceLevelObjectiveInput":{ "type":"structure", - "required":[ - "Name", - "SliConfig" - ], + "required":["Name"], "members":{ "Name":{ "shape":"ServiceLevelObjectiveName", @@ -396,11 +397,15 @@ }, "SliConfig":{ "shape":"ServiceLevelIndicatorConfig", - "documentation":"A structure that contains information about what service and what performance metric that this SLO will monitor.
" + "documentation":"If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
" + "documentation":"This structure contains the attributes that determine the goal of the SLO.
" }, "Tags":{ "shape":"TagList", @@ -472,10 +477,19 @@ "DurationUnit":{ "type":"string", "enum":[ + "MINUTE", + "HOUR", "DAY", "MONTH" ] }, + "EvaluationType":{ + "type":"string", + "enum":[ + "PeriodBased", + "RequestBased" + ] + }, "FaultDescription":{"type":"string"}, "GetServiceInput":{ "type":"structure", @@ -560,7 +574,7 @@ }, "AttainmentGoal":{ "shape":"AttainmentGoal", - "documentation":"The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
If you omit this parameter, 99 is used to represent 99% as the attainment goal.
" + "documentation":"The threshold that determines if the goal is being met.
If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.
If you omit this parameter, 99 is used to represent 99% as the attainment goal.
" }, "WarningThreshold":{ "shape":"WarningThreshold", @@ -992,7 +1006,7 @@ }, "AccountId":{ "shape":"AccountId", - "documentation":"The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
" + "documentation":"The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.
" } }, "documentation":"Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure.
" + }, + "BadCountMetric":{ + "shape":"MetricDataQueries", + "documentation":"If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure.
" + } + }, + "documentation":"This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
A structure that contains information about the metric that the SLO monitors.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"This value is the threshold that the observed metric values of the SLI metric are compared to.
" + }, + "ComparisonOperator":{ + "shape":"ServiceLevelIndicatorComparisonOperator", + "documentation":"The arithmetic operation used when comparing the specified metric to the threshold.
" + } + }, + "documentation":"This structure contains information about the performance metric that a request-based SLO monitors.
" + }, + "RequestBasedServiceLevelIndicatorConfig":{ + "type":"structure", + "required":["RequestBasedSliMetricConfig"], + "members":{ + "RequestBasedSliMetricConfig":{ + "shape":"RequestBasedServiceLevelIndicatorMetricConfig", + "documentation":"Use this structure to specify the metric to be used for the SLO.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.
The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.
This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.
" + }, + "RequestBasedServiceLevelIndicatorMetric":{ + "type":"structure", + "required":[ + "TotalRequestCountMetric", + "MonitoredRequestCountMetric" + ], + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
Type designates the type of object that this SLO is related to.
ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.
Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.
Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.
Environment specifies the location where this object is hosted, or what it belongs to.
If the SLO monitors a specific operation of the service, this field displays that operation name.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is observed for the metric defined in MonitoredRequestCountMetric.
This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
This structure contains the information about the metric that is used for a request-based SLO.
" + }, + "RequestBasedServiceLevelIndicatorMetricConfig":{ + "type":"structure", + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.
This is a string-to-string map. It can include the following fields.
Type designates the type of object this is.
ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.
Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.
Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.
Environment specifies the location where this object is hosted, or what it belongs to.
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
Use this structure to define the metric that you want to use as the \"total requests\" number for a request-based SLO. This result will be divided by the \"good request\" or \"bad request\" value defined in MonitoredRequestCountMetric.
Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
Use this structure to specify the information for the metric that a period-based SLO will monitor.
" + }, "ResourceId":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", @@ -1165,7 +1288,7 @@ }, "AttributeMaps":{ "shape":"AttributeMaps", - "documentation":"This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Applciation attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
The arithmetic operation used when comparing the specified metric to the threshold.
" } }, - "documentation":"This structure contains information about the performance metric that an SLO monitors.
" + "documentation":"This structure contains information about the performance metric that a period-based SLO monitors.
" }, "ServiceLevelIndicatorComparisonOperator":{ "type":"string", @@ -1291,14 +1414,14 @@ }, "MetricThreshold":{ "shape":"ServiceLevelIndicatorMetricThreshold", - "documentation":"The value that the SLI metric is compared to.
" + "documentation":"This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the observed Latency metric values are to be compared to.
The arithmetic operation to use when comparing the specified metric to the threshold.
" } }, - "documentation":"This structure specifies the information about the service and the performance metric that an SLO is to monitor.
" + "documentation":"This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor.
" }, "ServiceLevelIndicatorMetric":{ "type":"structure", @@ -1321,7 +1444,7 @@ "documentation":"If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.
" } }, - "documentation":"This structure contains the information about the metric that is used for the SLO.
" + "documentation":"This structure contains the information about the metric that is used for a period-based SLO.
" }, "ServiceLevelIndicatorMetricConfig":{ "type":"structure", @@ -1351,7 +1474,7 @@ "documentation":"If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
" } }, - "documentation":"Use this structure to specify the information for the metric that the SLO will monitor.
" + "documentation":"Use this structure to specify the information for the metric that a period-based SLO will monitor.
" }, "ServiceLevelIndicatorMetricThreshold":{ "type":"double", @@ -1377,7 +1500,6 @@ "Name", "CreatedTime", "LastUpdatedTime", - "Sli", "Goal" ], "members":{ @@ -1403,7 +1525,15 @@ }, "Sli":{ "shape":"ServiceLevelIndicator", - "documentation":"A structure containing information about the performance metric that this SLO monitors.
" + "documentation":"A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
" + }, + "RequestBasedSli":{ + "shape":"RequestBasedServiceLevelIndicator", + "documentation":"A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
" + }, + "EvaluationType":{ + "shape":"EvaluationType", + "documentation":"Displays whether this is a period-based SLO or a request-based SLO.
" }, "Goal":{"shape":"Goal"} }, @@ -1431,26 +1561,39 @@ "shape":"ServiceLevelObjectiveName", "documentation":"The name of the SLO that this report is for.
" }, + "EvaluationType":{ + "shape":"EvaluationType", + "documentation":"Displays whether this budget report is for a period-based SLO or a request-based SLO.
" + }, "BudgetStatus":{ "shape":"ServiceLevelObjectiveBudgetStatus", - "documentation":"The status of this SLO, as it relates to the error budget for the entire time interval.
OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.
WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.
BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.
INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.
The status of this SLO, as it relates to the error budget for the entire time interval.
OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.
WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.
BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.
INSUFFICIENT_DATA means that the specified start and end times were before the SLO was created, or that attainment data is missing.
A number between 0 and 100 that represents the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
" + "documentation":"A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.
If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.
" }, "TotalBudgetSeconds":{ "shape":"TotalBudgetSeconds", - "documentation":"The total number of seconds in the error budget for the interval.
" + "documentation":"The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
" }, "BudgetSecondsRemaining":{ "shape":"BudgetSecondsRemaining", - "documentation":"The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.
The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.
This field is included only if the SLO is a period-based SLO.
" + }, + "TotalBudgetRequests":{ + "shape":"TotalBudgetRequests", + "documentation":"This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.
This number can go up and down between reports with different time stamps, based on both how many total requests occur.
" + }, + "BudgetRequestsRemaining":{ + "shape":"BudgetRequestsRemaining", + "documentation":"This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.
This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.
" }, "Sli":{ "shape":"ServiceLevelIndicator", "documentation":"A structure that contains information about the performance metric that this SLO monitors.
" }, + "RequestBasedSli":{"shape":"RequestBasedServiceLevelIndicator"}, "Goal":{"shape":"Goal"} }, "documentation":"A structure containing an SLO budget report that you have requested.
" @@ -1613,14 +1756,14 @@ }, "AttributeMaps":{ "shape":"AttributeMaps", - "documentation":"This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Applciation attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
An array of structures that each contain information about one metric associated with this service.
" } }, - "documentation":"This structure contains information about one of your services that was discoverd by Application Signals
" + "documentation":"This structure contains information about one of your services that was discovered by Application Signals
" }, "StandardUnit":{ "type":"string", @@ -1742,6 +1885,10 @@ "exception":true }, "Timestamp":{"type":"timestamp"}, + "TotalBudgetRequests":{ + "type":"integer", + "box":true + }, "TotalBudgetSeconds":{ "type":"integer", "box":true @@ -1784,7 +1931,11 @@ }, "SliConfig":{ "shape":"ServiceLevelIndicatorConfig", - "documentation":"A structure that contains information about what performance metric this SLO will monitor.
" + "documentation":"If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
" + }, + "RequestBasedSliConfig":{ + "shape":"RequestBasedServiceLevelIndicatorConfig", + "documentation":"If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both SliConfig and RequestBasedSliConfig in the same operation.
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
" + "documentation":"Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
If a secret token was provided, it will be redacted in the response.
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
" + "documentation":"Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.
If a secret token was provided, it will be redacted in the response.
A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. Valid categories are limited to one of the following values.
INVOKE
Approval
Rule
A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is Rule.
The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as AWS.
The rule provider, such as the DeploymentWindow rule.
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.
If a secret token was provided, it will be redacted in the response.
The authentication applied to incoming webhook trigger requests.
" @@ -5451,7 +5451,7 @@ }, "authentication":{ "shape":"WebhookAuthenticationType", - "documentation":"Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.
If a secret token was provided, it will be redacted in the response.
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.
Learn more
" + "documentation":"This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.
Learn more
Amazon GameLift service locations for managed hosting.
" }, "CreateGameServerGroup":{ "name":"CreateGameServerGroup", @@ -746,7 +746,7 @@ {"shape":"NotFoundException"}, {"shape":"UnsupportedRegionException"} ], - "documentation":"Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.
Learn more
Setting up Amazon GameLift fleets
" + "documentation":"Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
" }, "DescribeFleetLocationCapacity":{ "name":"DescribeFleetLocationCapacity", @@ -763,7 +763,7 @@ {"shape":"NotFoundException"}, {"shape":"UnsupportedRegionException"} ], - "documentation":"Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.
Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity object is returned for the requested fleet location.
Learn more
Setting up Amazon GameLift fleets
" + "documentation":"Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.
Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity object is returned for the requested fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
" }, "DescribeFleetLocationUtilization":{ "name":"DescribeFleetLocationUtilization", @@ -780,7 +780,7 @@ {"shape":"NotFoundException"}, {"shape":"UnsupportedRegionException"} ], - "documentation":"Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization object is returned for the requested fleet location.
Learn more
Setting up Amazon GameLift fleets
" + "documentation":"Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization object is returned for the requested fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
" }, "DescribeFleetPortSettings":{ "name":"DescribeFleetPortSettings", @@ -1104,7 +1104,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets
To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.
EC2 fleets
With an EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.
Container fleets
With a container fleet (where compute type is CONTAINER), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.
Learn more
" + "documentation":"This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets
To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.
EC2 fleets
With an EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.
Container fleets
With a container fleet (where compute type is CONTAINER), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.
Learn more
" }, "GetComputeAuthToken":{ "name":"GetComputeAuthToken", @@ -2008,7 +2008,7 @@ }, "OperatingSystem":{ "shape":"OperatingSystem", - "documentation":"Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
" + "documentation":"Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
The type of operating system on the compute resource.
" + "documentation":"The type of operating system on the compute resource.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
The platform required for all containers in the container group definition.
" + "documentation":"The platform required for all containers in the container group definition.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
The maximum possible number of replica container groups that each fleet instance can have.
" } }, - "documentation":"This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.
Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:
If no desired value is set, Amazon GameLift places the calculated maximum.
If a desired number is set to a value higher than the calculated maximum, Amazon GameLift places the calculated maximum.
If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.
Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes
Returned by: DescribeFleetAttributes, CreateFleet
" + "documentation":"This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.
Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:
If no desired value is set, Amazon GameLift places the calculated maximum.
If a desired number is set to a value higher than the calculated maximum, fleet creation fails..
If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.
Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes
Returned by: DescribeFleetAttributes, CreateFleet
" }, "ContainerHealthCheck":{ "type":"structure", @@ -2817,7 +2817,7 @@ }, "OperatingSystem":{ "shape":"OperatingSystem", - "documentation":"The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.
If you have active fleets using the Windows Server 2012 operating system, you can continue to create new builds using this OS until October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016 when creating new Windows-based builds.
The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.
" + "documentation":"The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the request.
" + "documentation":"A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in Amazon Web Services Regions that support multiple locations. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more Amazon Web Services Region codes, such as us-west-2, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.
" + "documentation":"A list of labels to assign to the new resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.
" } } }, @@ -4924,7 +4924,7 @@ }, "EventCode":{ "shape":"EventCode", - "documentation":"The type of event being logged.
Fleet state transition events:
FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. Amazon GameLift has successfully downloaded the build and is now validating the build files.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. Amazon GameLift has successfully verified the build files and is now running the installation scripts.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. Amazon GameLift is trying to launch an instance and test the connectivity between the build and the Amazon GameLift Service via the Server SDK.
FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details.
Fleet creation events (ordered by fleet creation activity):
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, 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 runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.
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. For more information, see Debug Fleet Creation Issues.
FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.
FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your Amazon Web Services account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
INSTANCE_RECYCLED -- A spot instance was determined to have a high risk of interruption and is scheduled to be recycled once it has no active game sessions.
Server process events:
SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.
SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected (5 minutes). Check your game session log to see why InitSDK() was not called in time.
SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected (5 minutes) after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.
SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.
SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.
SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly within the time expected after OnProcessTerminate() was sent. Check your game session log to see why termination took longer than expected.
SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected (30 seconds) after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.
Game session events:
GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
The type of event being logged.
Fleet state transition events:
FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. Amazon GameLift is downloading the compressed build and running install scripts.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. Amazon GameLift has successfully installed build and is now validating the build files.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. Amazon GameLift has successfully verified the build files and is now launching a fleet instance.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. Amazon GameLift is launching a game server process on the fleet instance and is testing its connectivity with 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.
FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details.
Fleet creation events (ordered by fleet creation activity):
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 Amazon GameLiftis now extracting the build files from the uploaded build. 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 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 successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_COMPLETED_INSTALLER -- The game server build files were successfully installed and validation of the installation will begin soon.
FLEET_CREATION_FAILED_INSTALLER -- The installed failed while attempting to install the build files. This event indicates that the failure occurred before Amazon GameLift could start validation.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, 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 runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.
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. For more information, see Debug Fleet Creation Issues.
FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.
FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your Amazon Web Services account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
INSTANCE_RECYCLED -- A spot instance was determined to have a high risk of interruption and is scheduled to be recycled once it has no active game sessions.
Server process events:
SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.
SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected (5 minutes). Check your game session log to see why InitSDK() was not called in time.
SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected (5 minutes) after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.
SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.
SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.
SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly within the time expected after OnProcessTerminate() was sent. Check your game session log to see why termination took longer than expected.
SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected (30 seconds) after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.
Game session events:
GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
ACTIVE -- The fleet is now ready to host game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter continue to be valid.
" + "documentation":"This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration. Requests that use this parameter continue to be valid.
" }, "ServerLaunchParameters":{ "shape":"LaunchParametersStringModel", - "documentation":"This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter continue to be valid.
" + "documentation":"This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration. Requests that use this parameter continue to be valid.
" }, "LogPaths":{ "shape":"StringList", @@ -5101,7 +5103,7 @@ }, "OperatingSystem":{ "shape":"OperatingSystem", - "documentation":"The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is \"EC2\" or \"Container\".
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is \"EC2\" or \"Container\".
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
Operating system that is running on this EC2 instance.
" + "documentation":"Operating system that is running on this EC2 instance.
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
An Amazon Web Services Region code, such as us-west-2.
An Amazon Web Services Region code, such as us-west-2. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
A remote location where a multi-location fleet can deploy game servers for game hosting.
" @@ -6831,7 +6833,7 @@ "documentation":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html.
" + "documentation":"Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to CreateLocation.
" }, "LocationModelList":{ "type":"list", @@ -7184,7 +7186,7 @@ "members":{ "Message":{"shape":"NonEmptyString"} }, - "documentation":"THe requested resources was not found. The resource was either not created yet or deleted.
", + "documentation":"The requested resources was not found. The resource was either not created yet or deleted.
", "exception":true }, "NotReadyException":{ @@ -7579,11 +7581,11 @@ }, "IpAddress":{ "shape":"IpAddress", - "documentation":"The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP address.
" + "documentation":"The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP address. When registering an Anywhere fleet, an IP address is required.
" }, "Location":{ "shape":"LocationStringModel", - "documentation":"The name of a custom location to associate with the compute resource being registered.
" + "documentation":"The name of a custom location to associate with the compute resource being registered. This parameter is required when registering a compute for an Anywhere fleet.
" } } }, diff --git a/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json b/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json index c365d3614f..76500c7d3f 100644 --- a/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json +++ b/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json @@ -3774,7 +3774,8 @@ "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", - "FLINK-1_19" + "FLINK-1_19", + "FLINK-1_20" ] }, "S3ApplicationCodeLocationDescription":{ diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index ceebcbf23a..25495dadcc 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -4896,6 +4896,16 @@ "ml.r6id.32xlarge" ] }, + "AppLifecycleManagement":{ + "type":"structure", + "members":{ + "IdleSettings":{ + "shape":"IdleSettings", + "documentation":"Settings related to idle shutdown of Studio applications.
" + } + }, + "documentation":"Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
" + }, "AppList":{ "type":"list", "member":{"shape":"AppDetails"} @@ -7246,7 +7256,7 @@ "documentation":"Details of LifeCycle configuration for the instance group.
" }, "ExecutionRole":{ - "shape":"RoleArn", + "shape":"IAMRoleArn", "documentation":"The execution role for the instance group to assume.
" }, "ThreadsPerCore":{ @@ -7297,7 +7307,7 @@ "documentation":"Specifies the LifeCycle configuration for the instance group.
" }, "ExecutionRole":{ - "shape":"RoleArn", + "shape":"IAMRoleArn", "documentation":"Specifies an IAM execution role to be assumed by the instance group.
" }, "ThreadsPerCore":{ @@ -7630,6 +7640,10 @@ "LifecycleConfigArns":{ "shape":"LifecycleConfigArns", "documentation":"The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.
" + }, + "AppLifecycleManagement":{ + "shape":"AppLifecycleManagement", + "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
" } }, "documentation":"The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
" @@ -20818,6 +20832,12 @@ "type":"integer", "min":1 }, + "IAMRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/[\\w+=,.@-]{1,64}$" + }, "IamIdentity":{ "type":"structure", "members":{ @@ -20878,6 +20898,33 @@ "member":{"shape":"IdentityProviderOAuthSetting"}, "max":20 }, + "IdleSettings":{ + "type":"structure", + "members":{ + "LifecycleManagement":{ + "shape":"LifecycleManagement", + "documentation":"Indicates whether idle shutdown is activated for the application type.
" + }, + "IdleTimeoutInMinutes":{ + "shape":"IdleTimeoutInMinutes", + "documentation":"The time that SageMaker waits after the application becomes idle before shutting it down.
" + }, + "MinIdleTimeoutInMinutes":{ + "shape":"IdleTimeoutInMinutes", + "documentation":"The minimum value in minutes that custom idle shutdown can be set to by the user.
" + }, + "MaxIdleTimeoutInMinutes":{ + "shape":"IdleTimeoutInMinutes", + "documentation":"The maximum value in minutes that custom idle shutdown can be set to by the user.
" + } + }, + "documentation":"Settings related to idle shutdown of Studio applications.
" + }, + "IdleTimeoutInMinutes":{ + "type":"integer", + "max":525600, + "min":60 + }, "Image":{ "type":"structure", "required":[ @@ -22222,6 +22269,10 @@ "shape":"CodeRepositories", "documentation":"A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" }, + "AppLifecycleManagement":{ + "shape":"AppLifecycleManagement", + "documentation":"Indicates whether idle shutdown is activated for JupyterLab applications.
" + }, "EmrSettings":{ "shape":"EmrSettings", "documentation":"The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
" @@ -22714,6 +22765,13 @@ "type":"list", "member":{"shape":"StudioLifecycleConfigArn"} }, + "LifecycleManagement":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "LineageEntityParameters":{ "type":"map", "key":{"shape":"StringParameterValue"}, @@ -34634,6 +34692,16 @@ "min":1, "pattern":".*" }, + "SpaceAppLifecycleManagement":{ + "type":"structure", + "members":{ + "IdleSettings":{ + "shape":"SpaceIdleSettings", + "documentation":"Settings related to idle shutdown of Studio applications.
" + } + }, + "documentation":"Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.
" + }, "SpaceArn":{ "type":"string", "max":256, @@ -34642,7 +34710,11 @@ "SpaceCodeEditorAppSettings":{ "type":"structure", "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"} + "DefaultResourceSpec":{"shape":"ResourceSpec"}, + "AppLifecycleManagement":{ + "shape":"SpaceAppLifecycleManagement", + "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.
" + } }, "documentation":"The application settings for a Code Editor space.
" }, @@ -34693,6 +34765,16 @@ "max":16384, "min":5 }, + "SpaceIdleSettings":{ + "type":"structure", + "members":{ + "IdleTimeoutInMinutes":{ + "shape":"IdleTimeoutInMinutes", + "documentation":"The time that SageMaker waits after the application becomes idle before shutting it down.
" + } + }, + "documentation":"Settings related to idle shutdown of Studio applications in a space.
" + }, "SpaceJupyterLabAppSettings":{ "type":"structure", "members":{ @@ -34700,6 +34782,10 @@ "CodeRepositories":{ "shape":"CodeRepositories", "documentation":"A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" + }, + "AppLifecycleManagement":{ + "shape":"SpaceAppLifecycleManagement", + "documentation":"Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.
" } }, "documentation":"The settings for the JupyterLab application within a space.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index 2ca2051e78..7e9ca33423 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.12' +release = '1.35.13' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.