aws_sdk_gameliftstreams/client/

add_stream_group_locations.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AddStreamGroupLocations`](crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`identifier(impl Into<String>)`](crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder::set_identifier):<br>required: **true**<br><p>A stream group to add the specified locations to.</p> <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p><br>
    ///   - [`location_configurations(LocationConfiguration)`](crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder::location_configurations) / [`set_location_configurations(Option<Vec::<LocationConfiguration>>)`](crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder::set_location_configurations):<br>required: **true**<br><p>A set of one or more locations and the streaming capacity for each location.</p><br>
    /// - On success, responds with [`AddStreamGroupLocationsOutput`](crate::operation::add_stream_group_locations::AddStreamGroupLocationsOutput) with field(s):
    ///   - [`identifier(String)`](crate::operation::add_stream_group_locations::AddStreamGroupLocationsOutput::identifier): <p>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p>
    ///   - [`locations(Vec::<LocationState>)`](crate::operation::add_stream_group_locations::AddStreamGroupLocationsOutput::locations): <p>This value is set of locations, including their name, current status, and capacities.</p> <p>A location can be in one of the following states:</p> <ul>  <li>   <p><code>ACTIVATING</code>: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.</p></li>  <li>   <p><code>ACTIVE</code>: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.</p></li>  <li>   <p><code>ERROR</code>: Amazon GameLift Streams failed to set up this location. The <code>StatusReason</code> field describes the error. You can remove this location and try to add it again.</p></li>  <li>   <p><code>REMOVING</code>: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.</p></li> </ul>
    /// - On failure, responds with [`SdkError<AddStreamGroupLocationsError>`](crate::operation::add_stream_group_locations::AddStreamGroupLocationsError)
    pub fn add_stream_group_locations(&self) -> crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder {
        crate::operation::add_stream_group_locations::builders::AddStreamGroupLocationsFluentBuilder::new(self.handle.clone())
    }
}