scaleway.mnq.v1beta1 package

Submodules

scaleway.mnq.v1beta1.api module

class scaleway.mnq.v1beta1.api.MnqV1Beta1NatsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage Scaleway NATS accounts.

create_nats_account(*, region: str | None = None, name: str | None = None, project_id: str | None = None) → NatsAccount

Create a NATS account. Create a NATS account associated with a Project. :param region: Region to target. If none is passed will use default region from the config. :param name: NATS account name. :param project_id: Project containing the NATS account. :return: NatsAccount

Usage:

result = api.create_nats_account()

create_nats_credentials(*, nats_account_id: str, region: str | None = None, name: str | None = None) → NatsCredentials

Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID. :param nats_account_id: NATS account containing the credentials. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :return: NatsCredentials

Usage:

result = api.create_nats_credentials(
    nats_account_id="example",
)

delete_nats_account(*, nats_account_id: str, region: str | None = None) → None

Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted. :param nats_account_id: ID of the NATS account to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_nats_account(
    nats_account_id="example",
)

delete_nats_credentials(*, nats_credentials_id: str, region: str | None = None) → None

Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed. :param nats_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_nats_credentials(
    nats_credentials_id="example",
)

get_nats_account(*, nats_account_id: str, region: str | None = None) → NatsAccount

Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response. :param nats_account_id: ID of the NATS account to get. :param region: Region to target. If none is passed will use default region from the config. :return: NatsAccount

Usage:

result = api.get_nats_account(
    nats_account_id="example",
)

get_nats_credentials(*, nats_credentials_id: str, region: str | None = None) → NatsCredentials

Get NATS credentials. Retrieve an existing set of credentials, identified by the nats_credentials_id. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response. :param nats_credentials_id: ID of the credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: NatsCredentials

Usage:

result = api.get_nats_credentials(
    nats_credentials_id="example",
)

List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param page: Page number to return. :param page_size: Maximum number of NATS accounts to return per page. :param order_by: Order in which to return results. :return: ListNatsAccountsResponse

Usage:

result = api.list_nats_accounts()

List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param page: Page number to return. :param page_size: Maximum number of NATS accounts to return per page. :param order_by: Order in which to return results. :return: List[NatsAccount]

Usage:

result = api.list_nats_accounts_all()

List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param nats_account_id: Include only credentials for this NATS account. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListNatsCredentialsResponse

Usage:

result = api.list_nats_credentials()

List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param nats_account_id: Include only credentials for this NATS account. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[NatsCredentials]

Usage:

result = api.list_nats_credentials_all()

update_nats_account(*, nats_account_id: str, region: str | None = None, name: str | None = None) → NatsAccount

Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID. :param nats_account_id: ID of the NATS account to update. :param region: Region to target. If none is passed will use default region from the config. :param name: NATS account name. :return: NatsAccount

Usage:

result = api.update_nats_account(
    nats_account_id="example",
)

class scaleway.mnq.v1beta1.api.MnqV1Beta1SnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway Topics and Events.

activate_sns(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to activate the Topics and Events service. :return: SnsInfo

Usage:

result = api.activate_sns()

create_sns_credentials(*, region: str | None = None, project_id: str | None = None, name: str | None = None, permissions: SnsPermissions | None = None) → SnsCredentials

Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project containing the Topics and Events credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SnsCredentials

Usage:

result = api.create_sns_credentials()

deactivate_sns(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to deactivate the Topics and Events service. :return: SnsInfo

Usage:

result = api.deactivate_sns()

delete_sns_credentials(*, sns_credentials_id: str, region: str | None = None) → None

Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events. :param sns_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_sns_credentials(
    sns_credentials_id="example",
)

get_sns_credentials(*, sns_credentials_id: str, region: str | None = None) → SnsCredentials

Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. :param sns_credentials_id: ID of the Topics and Events credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: SnsCredentials

Usage:

result = api.get_sns_credentials(
    sns_credentials_id="example",
)

get_sns_info(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project to retrieve Topics and Events info from. :return: SnsInfo

Usage:

result = api.get_sns_info()

List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListSnsCredentialsResponse

Usage:

result = api.list_sns_credentials()

List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[SnsCredentials]

Usage:

result = api.list_sns_credentials_all()

update_sns_credentials(*, sns_credentials_id: str, region: str | None = None, name: str | None = None, permissions: SnsPermissions | None = None) → SnsCredentials

Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials’ name, or their permissions. :param sns_credentials_id: ID of the Topics and Events credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SnsCredentials

Usage:

result = api.update_sns_credentials(
    sns_credentials_id="example",
)

class scaleway.mnq.v1beta1.api.MnqV1Beta1SqsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway Queues.

activate_sqs(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to activate the Queues service. :return: SqsInfo

Usage:

result = api.activate_sqs()

create_sqs_credentials(*, region: str | None = None, project_id: str | None = None, name: str | None = None, permissions: SqsPermissions | None = None) → SqsCredentials

Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project containing the Queues credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SqsCredentials

Usage:

result = api.create_sqs_credentials()

deactivate_sqs(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to deactivate the Queues service. :return: SqsInfo

Usage:

result = api.deactivate_sqs()

delete_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None) → None

Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues. :param sqs_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_sqs_credentials(
    sqs_credentials_id="example",
)

get_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None) → SqsCredentials

Get Queues credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. :param sqs_credentials_id: ID of the Queues credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: SqsCredentials

Usage:

result = api.get_sqs_credentials(
    sqs_credentials_id="example",
)

get_sqs_info(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project to retrieve Queues info from. :return: SqsInfo

Usage:

result = api.get_sqs_info()

List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListSqsCredentialsResponse

Usage:

result = api.list_sqs_credentials()

List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[SqsCredentials]

Usage:

result = api.list_sqs_credentials_all()

update_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None, name: str | None = None, permissions: SqsPermissions | None = None) → SqsCredentials

Update Queues credentials. Update a set of Queues credentials. You can update the credentials’ name, or their permissions. :param sqs_credentials_id: ID of the Queues credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SqsCredentials

Usage:

result = api.update_sqs_credentials(
    sqs_credentials_id="example",
)

scaleway.mnq.v1beta1.marshalling module

scaleway.mnq.v1beta1.marshalling.marshal_NatsApiCreateNatsAccountRequest(request: NatsApiCreateNatsAccountRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_NatsApiCreateNatsCredentialsRequest(request: NatsApiCreateNatsCredentialsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_NatsApiUpdateNatsAccountRequest(request: NatsApiUpdateNatsAccountRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SnsApiActivateSnsRequest(request: SnsApiActivateSnsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SnsApiCreateSnsCredentialsRequest(request: SnsApiCreateSnsCredentialsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SnsApiDeactivateSnsRequest(request: SnsApiDeactivateSnsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SnsApiUpdateSnsCredentialsRequest(request: SnsApiUpdateSnsCredentialsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SnsPermissions(request: SnsPermissions, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SqsApiActivateSqsRequest(request: SqsApiActivateSqsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SqsApiCreateSqsCredentialsRequest(request: SqsApiCreateSqsCredentialsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SqsApiDeactivateSqsRequest(request: SqsApiDeactivateSqsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SqsApiUpdateSqsCredentialsRequest(request: SqsApiUpdateSqsCredentialsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.marshal_SqsPermissions(request: SqsPermissions, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.mnq.v1beta1.marshalling.unmarshal_File(data: Any) → File

scaleway.mnq.v1beta1.marshalling.unmarshal_ListNatsAccountsResponse(data: Any) → ListNatsAccountsResponse

scaleway.mnq.v1beta1.marshalling.unmarshal_ListNatsCredentialsResponse(data: Any) → ListNatsCredentialsResponse

scaleway.mnq.v1beta1.marshalling.unmarshal_ListSnsCredentialsResponse(data: Any) → ListSnsCredentialsResponse

scaleway.mnq.v1beta1.marshalling.unmarshal_ListSqsCredentialsResponse(data: Any) → ListSqsCredentialsResponse

scaleway.mnq.v1beta1.marshalling.unmarshal_NatsAccount(data: Any) → NatsAccount

scaleway.mnq.v1beta1.marshalling.unmarshal_NatsCredentials(data: Any) → NatsCredentials

scaleway.mnq.v1beta1.marshalling.unmarshal_SnsCredentials(data: Any) → SnsCredentials

scaleway.mnq.v1beta1.marshalling.unmarshal_SnsInfo(data: Any) → SnsInfo

scaleway.mnq.v1beta1.marshalling.unmarshal_SnsPermissions(data: Any) → SnsPermissions

scaleway.mnq.v1beta1.marshalling.unmarshal_SqsCredentials(data: Any) → SqsCredentials

scaleway.mnq.v1beta1.marshalling.unmarshal_SqsInfo(data: Any) → SqsInfo

scaleway.mnq.v1beta1.marshalling.unmarshal_SqsPermissions(data: Any) → SqsPermissions

scaleway.mnq.v1beta1.types module

class scaleway.mnq.v1beta1.types.File(name: 'str', content: 'str')

Bases: object

content: str: File content.

name: str: File name.

class scaleway.mnq.v1beta1.types.ListNatsAccountsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.types.ListNatsAccountsResponse(total_count: 'int', nats_accounts: 'List[NatsAccount]')

Bases: object

nats_accounts: List[NatsAccount]: NATS accounts on this page.

total_count: int: Total count of existing NATS accounts (matching any filters specified).

class scaleway.mnq.v1beta1.types.ListNatsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.types.ListNatsCredentialsResponse(total_count: 'int', nats_credentials: 'List[NatsCredentials]')

Bases: object

nats_credentials: List[NatsCredentials]: Credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.types.ListSnsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.types.ListSnsCredentialsResponse(total_count: 'int', sns_credentials: 'List[SnsCredentials]')

Bases: object

sns_credentials: List[SnsCredentials]: Topics and Events credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.types.ListSqsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.types.ListSqsCredentialsResponse(total_count: 'int', sqs_credentials: 'List[SqsCredentials]')

Bases: object

sqs_credentials: List[SqsCredentials]: Queues credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.types.NatsAccount(id: 'str', name: 'str', endpoint: 'str', project_id: 'str', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: NATS account creation date.

endpoint: str: Endpoint of the NATS service for this account.

id: str: NATS account ID.

name: str: NATS account name.

project_id: str: Project ID of the Project containing the NATS account.

region: str: Region where the NATS account is deployed.

updated_at: datetime | None = None: NATS account last modification date.

class scaleway.mnq.v1beta1.types.NatsApiCreateNatsAccountRequest(region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, project_id: 'Optional[str]' = None)

Bases: object

name: str | None = None: NATS account name.

project_id: str | None = None: Project containing the NATS account.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiCreateNatsCredentialsRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: Name of the credentials.

nats_account_id: str: NATS account containing the credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiDeleteNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_account_id: str: ID of the NATS account to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiDeleteNatsCredentialsRequest(nats_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_credentials_id: str: ID of the credentials to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiGetNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_account_id: str: ID of the NATS account to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiGetNatsCredentialsRequest(nats_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_credentials_id: str: ID of the credentials to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiListNatsAccountsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListNatsAccountsRequestOrderBy]' = <ListNatsAccountsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListNatsAccountsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of NATS accounts to return per page.

project_id: str | None = None: Include only NATS accounts in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiListNatsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, nats_account_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListNatsCredentialsRequestOrderBy]' = <ListNatsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

nats_account_id: str | None = None: Include only credentials for this NATS account.

order_by: ListNatsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only NATS accounts in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsApiUpdateNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: NATS account name.

nats_account_id: str: ID of the NATS account to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.NatsCredentials(id: 'str', name: 'str', nats_account_id: 'str', checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, credentials: 'Optional[File]' = None)

Bases: object

checksum: str: Checksum of the credentials file.

created_at: datetime | None = None: NATS credentials creation date.

credentials: File | None = None: Object containing the credentials file (Only returned by Create Nats Credentials call).

id: str: ID of the credentials.

name: str: Name of the credentials.

nats_account_id: str: NATS account containing the credentials.

updated_at: datetime | None = None: NATS credentials last modification date.

class scaleway.mnq.v1beta1.types.SnsApiActivateSnsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to activate the Topics and Events service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SnsApiCreateSnsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

project_id: str | None = None: Project containing the Topics and Events credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SnsApiDeactivateSnsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to deactivate the Topics and Events service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SnsApiDeleteSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the credentials to delete.

class scaleway.mnq.v1beta1.types.SnsApiGetSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the Topics and Events credentials to get.

class scaleway.mnq.v1beta1.types.SnsApiGetSnsInfoRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project to retrieve Topics and Events info from.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SnsApiListSnsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListSnsCredentialsRequestOrderBy]' = <ListSnsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListSnsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only Topics and Events credentials in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SnsApiUpdateSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the Topics and Events credentials to update.

class scaleway.mnq.v1beta1.types.SnsCredentials(id: 'str', name: 'str', project_id: 'str', region: 'ScwRegion', access_key: 'str', secret_key: 'str', secret_checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

access_key: str: Access key ID.

created_at: datetime | None = None: Credentials creation date.

id: str: ID of the credentials.

name: str: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

project_id: str: Project ID of the Project containing the credentials.

region: str: Region where the credentials exists.

secret_checksum: str: Checksum of the Secret key.

secret_key: str: Secret key ID (Only returned by Create Topics and Events Credentials call).

updated_at: datetime | None = None: Credentials last modification date.

class scaleway.mnq.v1beta1.types.SnsInfo(project_id: 'str', region: 'ScwRegion', status: 'SnsInfoStatus', sns_endpoint_url: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Topics and Events creation date.

project_id: str: Project ID of the Project containing the service.

region: str: Region of the service.

sns_endpoint_url: str: Endpoint of the Topics and Events service for this region and project.

status: SnsInfoStatus: Topics and Events activation status.

updated_at: datetime | None = None: Topics and Events last modification date.

class scaleway.mnq.v1beta1.types.SnsInfoStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

ENABLED = 'enabled'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.mnq.v1beta1.types.SnsPermissions(can_publish: 'Optional[bool]' = False, can_receive: 'Optional[bool]' = False, can_manage: 'Optional[bool]' = False)

Bases: object

can_manage: bool | None = False: Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions.

can_publish: bool | None = False: Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics).

can_receive: bool | None = False: Defines whether the credentials bearer can receive messages from the service (configure subscriptions).

class scaleway.mnq.v1beta1.types.SqsApiActivateSqsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to activate the Queues service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SqsApiCreateSqsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

project_id: str | None = None: Project containing the Queues credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SqsApiDeactivateSqsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to deactivate the Queues service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SqsApiDeleteSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the credentials to delete.

class scaleway.mnq.v1beta1.types.SqsApiGetSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the Queues credentials to get.

class scaleway.mnq.v1beta1.types.SqsApiGetSqsInfoRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project to retrieve Queues info from.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SqsApiListSqsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListSqsCredentialsRequestOrderBy]' = <ListSqsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListSqsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only Queues credentials in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.types.SqsApiUpdateSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the Queues credentials to update.

class scaleway.mnq.v1beta1.types.SqsCredentials(id: 'str', name: 'str', project_id: 'str', region: 'ScwRegion', access_key: 'str', secret_key: 'str', secret_checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

access_key: str: Access key ID.

created_at: datetime | None = None: Credentials creation date.

id: str: ID of the credentials.

name: str: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

project_id: str: Project ID of the Project containing the credentials.

region: str: Region where the credentials exists.

secret_checksum: str: Checksum of the Secret key.

secret_key: str: Secret key ID (Only returned by Create Queues Credentials call).

updated_at: datetime | None = None: Credentials last modification date.

class scaleway.mnq.v1beta1.types.SqsInfo(project_id: 'str', region: 'ScwRegion', status: 'SqsInfoStatus', sqs_endpoint_url: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Queues creation date.

project_id: str: Project ID of the Project containing the service.

region: str: Region of the service.

sqs_endpoint_url: str: Endpoint of the Queues service for this region and project.

status: SqsInfoStatus: Queues activation status.

updated_at: datetime | None = None: Queues last modification date.

class scaleway.mnq.v1beta1.types.SqsInfoStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

ENABLED = 'enabled'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.mnq.v1beta1.types.SqsPermissions(can_publish: 'Optional[bool]' = False, can_receive: 'Optional[bool]' = False, can_manage: 'Optional[bool]' = False)

Bases: object

can_manage: bool | None = False: Defines whether the credentials bearer can manage the associated Queues queues.

can_publish: bool | None = False: Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues).

can_receive: bool | None = False: Defines whether the credentials bearer can receive messages from Queues queues.

Module contents

class scaleway.mnq.v1beta1.File(name: 'str', content: 'str')

Bases: object

content: str: File content.

name: str: File name.

class scaleway.mnq.v1beta1.ListNatsAccountsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.ListNatsAccountsResponse(total_count: 'int', nats_accounts: 'List[NatsAccount]')

Bases: object

nats_accounts: List[NatsAccount]: NATS accounts on this page.

total_count: int: Total count of existing NATS accounts (matching any filters specified).

class scaleway.mnq.v1beta1.ListNatsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.ListNatsCredentialsResponse(total_count: 'int', nats_credentials: 'List[NatsCredentials]')

Bases: object

nats_credentials: List[NatsCredentials]: Credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.ListSnsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.ListSnsCredentialsResponse(total_count: 'int', sns_credentials: 'List[SnsCredentials]')

Bases: object

sns_credentials: List[SnsCredentials]: Topics and Events credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.ListSqsCredentialsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.mnq.v1beta1.ListSqsCredentialsResponse(total_count: 'int', sqs_credentials: 'List[SqsCredentials]')

Bases: object

sqs_credentials: List[SqsCredentials]: Queues credentials on this page.

total_count: int: Total count of existing credentials (matching any filters specified).

class scaleway.mnq.v1beta1.MnqV1Beta1NatsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage Scaleway NATS accounts.

create_nats_account(*, region: str | None = None, name: str | None = None, project_id: str | None = None) → NatsAccount

Create a NATS account. Create a NATS account associated with a Project. :param region: Region to target. If none is passed will use default region from the config. :param name: NATS account name. :param project_id: Project containing the NATS account. :return: NatsAccount

Usage:

result = api.create_nats_account()

create_nats_credentials(*, nats_account_id: str, region: str | None = None, name: str | None = None) → NatsCredentials

Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID. :param nats_account_id: NATS account containing the credentials. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :return: NatsCredentials

Usage:

result = api.create_nats_credentials(
    nats_account_id="example",
)

delete_nats_account(*, nats_account_id: str, region: str | None = None) → None

Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted. :param nats_account_id: ID of the NATS account to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_nats_account(
    nats_account_id="example",
)

delete_nats_credentials(*, nats_credentials_id: str, region: str | None = None) → None

Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed. :param nats_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_nats_credentials(
    nats_credentials_id="example",
)

get_nats_account(*, nats_account_id: str, region: str | None = None) → NatsAccount

Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response. :param nats_account_id: ID of the NATS account to get. :param region: Region to target. If none is passed will use default region from the config. :return: NatsAccount

Usage:

result = api.get_nats_account(
    nats_account_id="example",
)

get_nats_credentials(*, nats_credentials_id: str, region: str | None = None) → NatsCredentials

Get NATS credentials. Retrieve an existing set of credentials, identified by the nats_credentials_id. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response. :param nats_credentials_id: ID of the credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: NatsCredentials

Usage:

result = api.get_nats_credentials(
    nats_credentials_id="example",
)

List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param page: Page number to return. :param page_size: Maximum number of NATS accounts to return per page. :param order_by: Order in which to return results. :return: ListNatsAccountsResponse

Usage:

result = api.list_nats_accounts()

List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param page: Page number to return. :param page_size: Maximum number of NATS accounts to return per page. :param order_by: Order in which to return results. :return: List[NatsAccount]

Usage:

result = api.list_nats_accounts_all()

List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param nats_account_id: Include only credentials for this NATS account. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListNatsCredentialsResponse

Usage:

result = api.list_nats_credentials()

List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only NATS accounts in this Project. :param nats_account_id: Include only credentials for this NATS account. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[NatsCredentials]

Usage:

result = api.list_nats_credentials_all()

update_nats_account(*, nats_account_id: str, region: str | None = None, name: str | None = None) → NatsAccount

Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID. :param nats_account_id: ID of the NATS account to update. :param region: Region to target. If none is passed will use default region from the config. :param name: NATS account name. :return: NatsAccount

Usage:

result = api.update_nats_account(
    nats_account_id="example",
)

class scaleway.mnq.v1beta1.MnqV1Beta1SnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway Topics and Events.

activate_sns(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to activate the Topics and Events service. :return: SnsInfo

Usage:

result = api.activate_sns()

create_sns_credentials(*, region: str | None = None, project_id: str | None = None, name: str | None = None, permissions: SnsPermissions | None = None) → SnsCredentials

Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project containing the Topics and Events credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SnsCredentials

Usage:

result = api.create_sns_credentials()

deactivate_sns(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to deactivate the Topics and Events service. :return: SnsInfo

Usage:

result = api.deactivate_sns()

delete_sns_credentials(*, sns_credentials_id: str, region: str | None = None) → None

Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events. :param sns_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_sns_credentials(
    sns_credentials_id="example",
)

get_sns_credentials(*, sns_credentials_id: str, region: str | None = None) → SnsCredentials

Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. :param sns_credentials_id: ID of the Topics and Events credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: SnsCredentials

Usage:

result = api.get_sns_credentials(
    sns_credentials_id="example",
)

get_sns_info(*, region: str | None = None, project_id: str | None = None) → SnsInfo

Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project to retrieve Topics and Events info from. :return: SnsInfo

Usage:

result = api.get_sns_info()

List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListSnsCredentialsResponse

Usage:

result = api.list_sns_credentials()

List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[SnsCredentials]

Usage:

result = api.list_sns_credentials_all()

update_sns_credentials(*, sns_credentials_id: str, region: str | None = None, name: str | None = None, permissions: SnsPermissions | None = None) → SnsCredentials

Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials’ name, or their permissions. :param sns_credentials_id: ID of the Topics and Events credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SnsCredentials

Usage:

result = api.update_sns_credentials(
    sns_credentials_id="example",
)

class scaleway.mnq.v1beta1.MnqV1Beta1SqsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway Queues.

activate_sqs(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to activate the Queues service. :return: SqsInfo

Usage:

result = api.activate_sqs()

create_sqs_credentials(*, region: str | None = None, project_id: str | None = None, name: str | None = None, permissions: SqsPermissions | None = None) → SqsCredentials

Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project containing the Queues credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SqsCredentials

Usage:

result = api.create_sqs_credentials()

deactivate_sqs(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project on which to deactivate the Queues service. :return: SqsInfo

Usage:

result = api.deactivate_sqs()

delete_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None) → None

Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues. :param sqs_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_sqs_credentials(
    sqs_credentials_id="example",
)

get_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None) → SqsCredentials

Get Queues credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. :param sqs_credentials_id: ID of the Queues credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: SqsCredentials

Usage:

result = api.get_sqs_credentials(
    sqs_credentials_id="example",
)

get_sqs_info(*, region: str | None = None, project_id: str | None = None) → SqsInfo

Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project to retrieve Queues info from. :return: SqsInfo

Usage:

result = api.get_sqs_info()

List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: ListSqsCredentialsResponse

Usage:

result = api.list_sqs_credentials()

List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. :return: List[SqsCredentials]

Usage:

result = api.list_sqs_credentials_all()

update_sqs_credentials(*, sqs_credentials_id: str, region: str | None = None, name: str | None = None, permissions: SqsPermissions | None = None) → SqsCredentials

Update Queues credentials. Update a set of Queues credentials. You can update the credentials’ name, or their permissions. :param sqs_credentials_id: ID of the Queues credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: SqsCredentials

Usage:

result = api.update_sqs_credentials(
    sqs_credentials_id="example",
)

class scaleway.mnq.v1beta1.NatsAccount(id: 'str', name: 'str', endpoint: 'str', project_id: 'str', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: NATS account creation date.

endpoint: str: Endpoint of the NATS service for this account.

id: str: NATS account ID.

name: str: NATS account name.

project_id: str: Project ID of the Project containing the NATS account.

region: str: Region where the NATS account is deployed.

updated_at: datetime | None = None: NATS account last modification date.

class scaleway.mnq.v1beta1.NatsApiCreateNatsAccountRequest(region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, project_id: 'Optional[str]' = None)

Bases: object

name: str | None = None: NATS account name.

project_id: str | None = None: Project containing the NATS account.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiCreateNatsCredentialsRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: Name of the credentials.

nats_account_id: str: NATS account containing the credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiDeleteNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_account_id: str: ID of the NATS account to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiDeleteNatsCredentialsRequest(nats_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_credentials_id: str: ID of the credentials to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiGetNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_account_id: str: ID of the NATS account to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiGetNatsCredentialsRequest(nats_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

nats_credentials_id: str: ID of the credentials to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiListNatsAccountsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListNatsAccountsRequestOrderBy]' = <ListNatsAccountsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListNatsAccountsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of NATS accounts to return per page.

project_id: str | None = None: Include only NATS accounts in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiListNatsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, nats_account_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListNatsCredentialsRequestOrderBy]' = <ListNatsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

nats_account_id: str | None = None: Include only credentials for this NATS account.

order_by: ListNatsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only NATS accounts in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsApiUpdateNatsAccountRequest(nats_account_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: NATS account name.

nats_account_id: str: ID of the NATS account to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.NatsCredentials(id: 'str', name: 'str', nats_account_id: 'str', checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, credentials: 'Optional[File]' = None)

Bases: object

checksum: str: Checksum of the credentials file.

created_at: datetime | None = None: NATS credentials creation date.

credentials: File | None = None: Object containing the credentials file (Only returned by Create Nats Credentials call).

id: str: ID of the credentials.

name: str: Name of the credentials.

nats_account_id: str: NATS account containing the credentials.

updated_at: datetime | None = None: NATS credentials last modification date.

class scaleway.mnq.v1beta1.SnsApiActivateSnsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to activate the Topics and Events service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SnsApiCreateSnsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

project_id: str | None = None: Project containing the Topics and Events credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SnsApiDeactivateSnsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to deactivate the Topics and Events service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SnsApiDeleteSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the credentials to delete.

class scaleway.mnq.v1beta1.SnsApiGetSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the Topics and Events credentials to get.

class scaleway.mnq.v1beta1.SnsApiGetSnsInfoRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project to retrieve Topics and Events info from.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SnsApiListSnsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListSnsCredentialsRequestOrderBy]' = <ListSnsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListSnsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only Topics and Events credentials in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SnsApiUpdateSnsCredentialsRequest(sns_credentials_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_credentials_id: str: ID of the Topics and Events credentials to update.

class scaleway.mnq.v1beta1.SnsCredentials(id: 'str', name: 'str', project_id: 'str', region: 'ScwRegion', access_key: 'str', secret_key: 'str', secret_checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, permissions: 'Optional[SnsPermissions]' = None)

Bases: object

access_key: str: Access key ID.

created_at: datetime | None = None: Credentials creation date.

id: str: ID of the credentials.

name: str: Name of the credentials.

permissions: SnsPermissions | None = None: Permissions associated with these credentials.

project_id: str: Project ID of the Project containing the credentials.

region: str: Region where the credentials exists.

secret_checksum: str: Checksum of the Secret key.

secret_key: str: Secret key ID (Only returned by Create Topics and Events Credentials call).

updated_at: datetime | None = None: Credentials last modification date.

class scaleway.mnq.v1beta1.SnsInfo(project_id: 'str', region: 'ScwRegion', status: 'SnsInfoStatus', sns_endpoint_url: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Topics and Events creation date.

project_id: str: Project ID of the Project containing the service.

region: str: Region of the service.

sns_endpoint_url: str: Endpoint of the Topics and Events service for this region and project.

status: SnsInfoStatus: Topics and Events activation status.

updated_at: datetime | None = None: Topics and Events last modification date.

class scaleway.mnq.v1beta1.SnsInfoStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

ENABLED = 'enabled'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.mnq.v1beta1.SnsPermissions(can_publish: 'Optional[bool]' = False, can_receive: 'Optional[bool]' = False, can_manage: 'Optional[bool]' = False)

Bases: object

can_manage: bool | None = False: Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions.

can_publish: bool | None = False: Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics).

can_receive: bool | None = False: Defines whether the credentials bearer can receive messages from the service (configure subscriptions).

class scaleway.mnq.v1beta1.SqsApiActivateSqsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to activate the Queues service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SqsApiCreateSqsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

project_id: str | None = None: Project containing the Queues credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SqsApiDeactivateSqsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project on which to deactivate the Queues service.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SqsApiDeleteSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the credentials to delete.

class scaleway.mnq.v1beta1.SqsApiGetSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the Queues credentials to get.

class scaleway.mnq.v1beta1.SqsApiGetSqsInfoRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: Project to retrieve Queues info from.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SqsApiListSqsCredentialsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListSqsCredentialsRequestOrderBy]' = <ListSqsCredentialsRequestOrderBy.CREATED_AT_ASC: 'created_at_asc'>)

Bases: object

order_by: ListSqsCredentialsRequestOrderBy | None = 'created_at_asc': Order in which to return results.

page: int | None = 0: Page number to return.

page_size: int | None = 0: Maximum number of credentials to return per page.

project_id: str | None = None: Include only Queues credentials in this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.mnq.v1beta1.SqsApiUpdateSqsCredentialsRequest(sqs_credentials_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

name: str | None = None: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sqs_credentials_id: str: ID of the Queues credentials to update.

class scaleway.mnq.v1beta1.SqsCredentials(id: 'str', name: 'str', project_id: 'str', region: 'ScwRegion', access_key: 'str', secret_key: 'str', secret_checksum: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, permissions: 'Optional[SqsPermissions]' = None)

Bases: object

access_key: str: Access key ID.

created_at: datetime | None = None: Credentials creation date.

id: str: ID of the credentials.

name: str: Name of the credentials.

permissions: SqsPermissions | None = None: Permissions associated with these credentials.

project_id: str: Project ID of the Project containing the credentials.

region: str: Region where the credentials exists.

secret_checksum: str: Checksum of the Secret key.

secret_key: str: Secret key ID (Only returned by Create Queues Credentials call).

updated_at: datetime | None = None: Credentials last modification date.

class scaleway.mnq.v1beta1.SqsInfo(project_id: 'str', region: 'ScwRegion', status: 'SqsInfoStatus', sqs_endpoint_url: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Queues creation date.

project_id: str: Project ID of the Project containing the service.

region: str: Region of the service.

sqs_endpoint_url: str: Endpoint of the Queues service for this region and project.

status: SqsInfoStatus: Queues activation status.

updated_at: datetime | None = None: Queues last modification date.

class scaleway.mnq.v1beta1.SqsInfoStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

ENABLED = 'enabled'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.mnq.v1beta1.SqsPermissions(can_publish: 'Optional[bool]' = False, can_receive: 'Optional[bool]' = False, can_manage: 'Optional[bool]' = False)

Bases: object

can_manage: bool | None = False: Defines whether the credentials bearer can manage the associated Queues queues.

can_publish: bool | None = False: Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues).

can_receive: bool | None = False: Defines whether the credentials bearer can receive messages from Queues queues.