aws_sdk_gamelift/client/
get_compute_auth_token.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetComputeAuthToken`](crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`fleet_id(impl Into<String>)`](crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder::set_fleet_id):<br>required: **true**<br><p>A unique identifier for the fleet that the compute is registered to.</p><br>
7    ///   - [`compute_name(impl Into<String>)`](crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder::compute_name) / [`set_compute_name(Option<String>)`](crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder::set_compute_name):<br>required: **true**<br><p>The name of the compute resource you are requesting the authentication token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID.</p><br>
8    /// - On success, responds with [`GetComputeAuthTokenOutput`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput) with field(s):
9    ///   - [`fleet_id(Option<String>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::fleet_id): <p>A unique identifier for the fleet that the compute is registered to.</p>
10    ///   - [`fleet_arn(Option<String>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::fleet_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>    ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912   </region></code>.</p>
11    ///   - [`compute_name(Option<String>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::compute_name): <p>The name of the compute resource that the authentication token is issued to.</p>
12    ///   - [`compute_arn(Option<String>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::compute_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to an Amazon GameLift Servers compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>    ::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912   </region></code>.</p>
13    ///   - [`auth_token(Option<String>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::auth_token): <p>A valid temporary authentication token.</p>
14    ///   - [`expiration_timestamp(Option<DateTime>)`](crate::operation::get_compute_auth_token::GetComputeAuthTokenOutput::expiration_timestamp): <p>The amount of time until the authentication token is no longer valid.</p>
15    /// - On failure, responds with [`SdkError<GetComputeAuthTokenError>`](crate::operation::get_compute_auth_token::GetComputeAuthTokenError)
16    pub fn get_compute_auth_token(&self) -> crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder {
17        crate::operation::get_compute_auth_token::builders::GetComputeAuthTokenFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_gamelift/client/get_compute_auth_token.rs

aws_sdk_gamelift/client/
get_compute_auth_token.rs
