Metadata-Version: 2.4
Name: rboto-signin
Version: 0.1.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: AsyncIO
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: rboto==0.1.0
License-File: LICENSE
Summary: rboto: async-only, typed Python client for AWS Sign-In, powered by Rust. Alpha preview.
Keywords: rboto,aws,signin,asyncio,typing,rust
Home-Page: https://github.com/ferrumio/rboto
Author-email: Leandro Cavalcante Damascena <leandro.damascena@gmail.com>
License-Expression: Apache-2.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/ferrumio/rboto/releases
Project-URL: Documentation, https://ferrumio.github.io/rboto/clients/
Project-URL: Homepage, https://ferrumio.github.io/rboto/
Project-URL: Issues, https://github.com/ferrumio/rboto/issues
Project-URL: Repository, https://github.com/ferrumio/rboto

<!-- Generated by rboto-codegen. Edit the descriptor, template, or example source. -->
# rboto-signin

rboto is an independent project maintained by [Ferrumio](https://github.com/ferrumio).
It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

**Preview (Alpha).** rboto is under active development. APIs may change between releases.

rboto provides an **async-only, typed Python client for AWS Sign-In**,
powered by Rust. This package contains `SignInClient` and
**11 operations**.

## Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

```bash
python -m pip install "rboto[signin]"
```

You can also install `rboto-signin` directly; it installs the matching
`rboto` package. Only the selected service is installed.

These are the package names to use when a release is available on your package index.
If your index has no release yet, follow the
[source installation instructions](https://ferrumio.github.io/rboto/getting-started/).

## Usage

Configure credentials through your environment, shared profile, or workload role.
The example uses `us-east-1`; select a region where your service and resources are available.
Resource names, identifiers, input files, and model IDs in the example are placeholders
to replace with your own.

```python
import asyncio

from rboto import SignInClient


async def main() -> None:
    client = SignInClient(region="us-east-1")
    response = await client.get_console_authorization_configuration()
    print(response.target_id, response.console_authorization_enabled)


if __name__ == "__main__":
    asyncio.run(main())
```

In an application with an event loop, call `await main()` instead of `asyncio.run(main())`.
Reuse the client across calls. Constructing a client does not send a request.

## API conventions

- Import the client with `from rboto import SignInClient`.
- Every operation is asynchronous: use `await client.method(...)`.
- Operation arguments are keyword-only and use the Python names listed below.
- Structured inputs use typed dictionaries and tagged unions from `rboto_signin.types`.
- Regular responses expose typed attributes; `response.to_dict()` converts them to a dictionary.
- Event-stream responses may be typed dictionaries containing async iterators. Follow the
  declared return type; consume event streams with `async for`.
- Byte streams are consumed asynchronously. `await stream.read()` buffers the complete body;
  iterate the stream when processing a large response.
- Direct operation calls return one page.
- Use `async for page in client.paginators.method(...)` for supported paginated operations.
  Paginators accept the same typed arguments as the corresponding client method.

- Catch modeled exceptions from `rboto_signin.exceptions`. Their `error_code`,
  `message`, and `operation_name` identify service failures.

Clients also accept `profile`, `endpoint_url`, or shared `Session` settings.
See [configuration](https://ferrumio.github.io/rboto/guides/configuration/),
[errors](https://ferrumio.github.io/rboto/guides/errors/), and
[streaming](https://ferrumio.github.io/rboto/guides/streaming/).

## Operations

This is the complete operation catalog for this generated package. “Required arguments”
lists arguments without defaults in the Python signature. Service-side conditions may
require additional arguments. Each method links to its complete signature, including
optional arguments. Nested input definitions are in `rboto_signin.types`;
native response definitions are in the package's `_native.pyi`.

| Method | Required arguments | Return type |
|---|---|---|
| [`create_o_auth2_token`](#create_o_auth2_token) | <code>token_input: CreateOAuth2TokenRequestBody</code> | <code>CreateOAuth2TokenOutput</code> |
| [`create_o_auth2_token_with_iam`](#create_o_auth2_token_with_iam) | <code>grant_type: str</code>, <code>resource: str</code> | <code>CreateOAuth2TokenWithIAMOutput</code> |
| [`delete_console_authorization_configuration`](#delete_console_authorization_configuration) | None | <code>DeleteConsoleAuthorizationConfigurationOutput</code> |
| [`delete_resource_permission_statement`](#delete_resource_permission_statement) | <code>statement_id: str</code> | <code>DeleteResourcePermissionStatementOutput</code> |
| [`get_console_authorization_configuration`](#get_console_authorization_configuration) | None | <code>GetConsoleAuthorizationConfigurationOutput</code> |
| [`get_resource_policy`](#get_resource_policy) | None | <code>GetResourcePolicyOutput</code> |
| [`introspect_o_auth2_token_with_iam`](#introspect_o_auth2_token_with_iam) | <code>token: str</code> | <code>IntrospectOAuth2TokenWithIAMOutput</code> |
| [`list_resource_permission_statements`](#list_resource_permission_statements) | None | <code>ListResourcePermissionStatementsOutput</code> |
| [`put_console_authorization_configuration`](#put_console_authorization_configuration) | None | <code>PutConsoleAuthorizationConfigurationOutput</code> |
| [`put_resource_permission_statement`](#put_resource_permission_statement) | None | <code>PutResourcePermissionStatementOutput</code> |
| [`revoke_o_auth2_token_with_iam`](#revoke_o_auth2_token_with_iam) | <code>token: str</code> | <code>RevokeOAuth2TokenWithIAMOutput</code> |

## Complete signatures

### create_o_auth2_token

```python
async def create_o_auth2_token(
    *,
    token_input: CreateOAuth2TokenRequestBody,
) -> CreateOAuth2TokenOutput: ...
```


### create_o_auth2_token_with_iam

```python
async def create_o_auth2_token_with_iam(
    *,
    grant_type: str,
    resource: str,
) -> CreateOAuth2TokenWithIAMOutput: ...
```


### delete_console_authorization_configuration

```python
async def delete_console_authorization_configuration(
    *,
    target_id: str | None = None,
) -> DeleteConsoleAuthorizationConfigurationOutput: ...
```


### delete_resource_permission_statement

```python
async def delete_resource_permission_statement(
    *,
    statement_id: str,
    client_token: str | None = None,
) -> DeleteResourcePermissionStatementOutput: ...
```


### get_console_authorization_configuration

```python
async def get_console_authorization_configuration(
    *,
    target_id: str | None = None,
) -> GetConsoleAuthorizationConfigurationOutput: ...
```


### get_resource_policy

```python
async def get_resource_policy() -> GetResourcePolicyOutput: ...
```


### introspect_o_auth2_token_with_iam

```python
async def introspect_o_auth2_token_with_iam(
    *,
    token: str,
    token_type_hint: str | None = None,
) -> IntrospectOAuth2TokenWithIAMOutput: ...
```


### list_resource_permission_statements

```python
async def list_resource_permission_statements(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListResourcePermissionStatementsOutput: ...
```

Also available as `client.paginators.list_resource_permission_statements(...)`, returning an
async iterator of the response type above.


### put_console_authorization_configuration

```python
async def put_console_authorization_configuration(
    *,
    target_id: str | None = None,
) -> PutConsoleAuthorizationConfigurationOutput: ...
```


### put_resource_permission_statement

```python
async def put_resource_permission_statement(
    *,
    source_vpc: str | None = None,
    signin_source_vpce: str | None = None,
    console_source_vpce: str | None = None,
    vpc_source_ip: str | None = None,
    source_ip: str | None = None,
    requested_region: str | None = None,
    excluded_principal: str | None = None,
    client_token: str | None = None,
) -> PutResourcePermissionStatementOutput: ...
```


### revoke_o_auth2_token_with_iam

```python
async def revoke_o_auth2_token_with_iam(
    *,
    token: str,
) -> RevokeOAuth2TokenWithIAMOutput: ...
```


## Links

- [Service guide](https://ferrumio.github.io/rboto/clients/)
- [Repository](https://github.com/ferrumio/rboto)
- [Issues](https://github.com/ferrumio/rboto/issues)
- [Releases](https://github.com/ferrumio/rboto/releases)

Licensed under Apache-2.0.

