aws_sdk_cognitoidentityprovider/client/
describe_resource_server.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 [`DescribeResourceServer`](crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that hosts the resource server.</p><br>
7    ///   - [`identifier(impl Into<String>)`](crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder::set_identifier):<br>required: **true**<br><p>A unique resource server identifier for the resource server. The identifier can be an API friendly name like <code>solar-system-data</code>. You can also set an API URL like <code>https://solar-system-data-api.example.com</code> as your identifier.</p> <p>Amazon Cognito represents scopes in the access token in the format <code>$resource-server-identifier/$scope</code>. Longer scope-identifier strings increase the size of your access tokens.</p><br>
8    /// - On success, responds with [`DescribeResourceServerOutput`](crate::operation::describe_resource_server::DescribeResourceServerOutput) with field(s):
9    ///   - [`resource_server(Option<ResourceServerType>)`](crate::operation::describe_resource_server::DescribeResourceServerOutput::resource_server): <p>The details of the requested resource server.</p>
10    /// - On failure, responds with [`SdkError<DescribeResourceServerError>`](crate::operation::describe_resource_server::DescribeResourceServerError)
11    pub fn describe_resource_server(&self) -> crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder {
12        crate::operation::describe_resource_server::builders::DescribeResourceServerFluentBuilder::new(self.handle.clone())
13    }
14}