symbols:
# region models
'ApimodelAppItem@py.csm.mod':
id: 'ApimodelAppItem@py.csm.mod'
name: 'ApimodelAppItem'
type: 'model'
fields:
'app_id':
type: 'str'
required: true
'app_name':
type: 'str'
required: true
'app_status':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'game_name':
type: 'str'
required: true
'is_resource_applied':
type: 'bool'
required: true
'scenario':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'vm_sharing_configuration':
type: 'str'
required: true
'app_repo_arn':
type: 'str'
required: false
'app_repo_url':
type: 'str'
required: false
'autoscaling':
type: 'ApimodelAutoscalingResponse'
required: false
'base_path':
type: 'str'
required: false
'cpu':
type: 'ApimodelCPUResponse'
required: false
'deleted_at':
type: 'str'
required: false
'deployment_created_at':
type: 'str'
required: false
'deployment_id':
type: 'str'
required: false
'deployment_image_tag':
type: 'str'
required: false
'description':
type: 'str'
required: false
'memory':
type: 'ApimodelMemoryResponse'
required: false
'message':
type: 'str'
required: false
'redeployment_info':
type: 'ModelAppRedeploymentInfo'
required: false
'replica':
type: 'ApimodelReplicaResponse'
required: false
'service_public_url':
type: 'str'
required: false
'service_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_app_item.py'
example: |-
apimodel_app_item = csm_models.ApimodelAppItem.create(...)
'ApimodelAutoscalingRequest@py.csm.mod':
id: 'ApimodelAutoscalingRequest@py.csm.mod'
name: 'ApimodelAutoscalingRequest'
type: 'model'
fields:
'target_cpu_utilization_percent':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_autoscaling_request.py'
example: |-
apimodel_autoscaling_request = csm_models.ApimodelAutoscalingRequest.create(...)
'ApimodelAutoscalingResponse@py.csm.mod':
id: 'ApimodelAutoscalingResponse@py.csm.mod'
name: 'ApimodelAutoscalingResponse'
type: 'model'
fields:
'target_cpu_utilization_percent':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_autoscaling_response.py'
example: |-
apimodel_autoscaling_response = csm_models.ApimodelAutoscalingResponse.create(...)
'ApimodelBulkSubscribeItem@py.csm.mod':
id: 'ApimodelBulkSubscribeItem@py.csm.mod'
name: 'ApimodelBulkSubscribeItem'
type: 'model'
fields:
'notification_type':
type: 'Dict[str, bool]'
required: true
'email_address':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_bulk_subscribe_item.py'
example: |-
apimodel_bulk_subscribe_item = csm_models.ApimodelBulkSubscribeItem.create(...)
'ApimodelBulkSubscribeRequest@py.csm.mod':
id: 'ApimodelBulkSubscribeRequest@py.csm.mod'
name: 'ApimodelBulkSubscribeRequest'
type: 'model'
fields:
'subscribers':
type: 'List[ApimodelBulkSubscribeItem]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_bulk_subscribe_request.py'
example: |-
apimodel_bulk_subscribe_request = csm_models.ApimodelBulkSubscribeRequest.create(...)
'ApimodelCPURequest@py.csm.mod':
id: 'ApimodelCPURequest@py.csm.mod'
name: 'ApimodelCPURequest'
type: 'model'
fields:
'request_cpu':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_cpu_request.py'
example: |-
apimodel_cpu_request = csm_models.ApimodelCPURequest.create(...)
'ApimodelCPUResponse@py.csm.mod':
id: 'ApimodelCPUResponse@py.csm.mod'
name: 'ApimodelCPUResponse'
type: 'model'
fields:
'request_cpu':
type: 'int'
required: true
'cpu_limit':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_cpu_response.py'
example: |-
apimodel_cpu_response = csm_models.ApimodelCPUResponse.create(...)
'ApimodelCreateAppV2Request@py.csm.mod':
id: 'ApimodelCreateAppV2Request@py.csm.mod'
name: 'ApimodelCreateAppV2Request'
type: 'model'
fields:
'scenario':
type: 'str'
required: true
'autoscaling':
type: 'ApimodelAutoscalingRequest'
required: false
'cpu':
type: 'ApimodelCPURequest'
required: false
'description':
type: 'str'
required: false
'memory':
type: 'ApimodelMemoryRequest'
required: false
'replica':
type: 'ApimodelReplicaRequest'
required: false
'vm_sharing_configuration':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_app_v2_request.py'
example: |-
apimodel_create_app_v2_request = csm_models.ApimodelCreateAppV2Request.create(...)
'ApimodelCreateDeploymentV2Request@py.csm.mod':
id: 'ApimodelCreateDeploymentV2Request@py.csm.mod'
name: 'ApimodelCreateDeploymentV2Request'
type: 'model'
fields:
'image_tag':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_deployment_v2_request.py'
example: |-
apimodel_create_deployment_v2_request = csm_models.ApimodelCreateDeploymentV2Request.create(...)
'ApimodelCreateDeploymentV2Response@py.csm.mod':
id: 'ApimodelCreateDeploymentV2Response@py.csm.mod'
name: 'ApimodelCreateDeploymentV2Response'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_deployment_v2_response.py'
example: |-
apimodel_create_deployment_v2_response = csm_models.ApimodelCreateDeploymentV2Response.create(...)
'ApimodelCreateNoSQLAppDatabaseRequest@py.csm.mod':
id: 'ApimodelCreateNoSQLAppDatabaseRequest@py.csm.mod'
name: 'ApimodelCreateNoSQLAppDatabaseRequest'
type: 'model'
fields:
'db_name':
type: 'str'
required: true
'password':
type: 'str'
required: true
'username':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_no_sql_app_database_request.py'
example: |-
apimodel_create_no_sql_app_database_request = csm_models.ApimodelCreateNoSQLAppDatabaseRequest.create(...)
'ApimodelCreateNoSQLDatabaseCredentialRequest@py.csm.mod':
id: 'ApimodelCreateNoSQLDatabaseCredentialRequest@py.csm.mod'
name: 'ApimodelCreateNoSQLDatabaseCredentialRequest'
type: 'model'
fields:
'password':
type: 'str'
required: true
'username':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_no_sql_database_credential_request.py'
example: |-
apimodel_create_no_sql_database_credential_request = csm_models.ApimodelCreateNoSQLDatabaseCredentialRequest.create(...)
'ApimodelCreateSubscriptionRequest@py.csm.mod':
id: 'ApimodelCreateSubscriptionRequest@py.csm.mod'
name: 'ApimodelCreateSubscriptionRequest'
type: 'model'
fields:
'topic_names':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_subscription_request.py'
example: |-
apimodel_create_subscription_request = csm_models.ApimodelCreateSubscriptionRequest.create(...)
'ApimodelCreateSubscriptionResponse@py.csm.mod':
id: 'ApimodelCreateSubscriptionResponse@py.csm.mod'
name: 'ApimodelCreateSubscriptionResponse'
type: 'model'
fields:
'data':
type: 'List[ApimodelTopicSubscription]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_subscription_response.py'
example: |-
apimodel_create_subscription_response = csm_models.ApimodelCreateSubscriptionResponse.create(...)
'ApimodelCreateTopicRequest@py.csm.mod':
id: 'ApimodelCreateTopicRequest@py.csm.mod'
name: 'ApimodelCreateTopicRequest'
type: 'model'
fields:
'topic_name':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_create_topic_request.py'
example: |-
apimodel_create_topic_request = csm_models.ApimodelCreateTopicRequest.create(...)
'ApimodelCSMAppLimitsResponse@py.csm.mod':
id: 'ApimodelCSMAppLimitsResponse@py.csm.mod'
name: 'ApimodelCSMAppLimitsResponse'
type: 'model'
fields:
'autoscaling':
type: 'ModelCSMAutoscalingDefaults'
required: true
'extend_app_cpu_limit':
type: 'int'
required: true
'extend_app_event_handler_cpu_limit':
type: 'int'
required: true
'extend_app_memory_limit':
type: 'int'
required: true
'extend_app_replica_limit':
type: 'int'
required: true
'extend_appe_event_handler_memory_limit':
type: 'int'
required: true
'max_subscriber_count':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_csm_app_limits_response.py'
example: |-
apimodel_csm_app_limits_response = csm_models.ApimodelCSMAppLimitsResponse.create(...)
'ApimodelDeleteNoSQLResourceResponse@py.csm.mod':
id: 'ApimodelDeleteNoSQLResourceResponse@py.csm.mod'
name: 'ApimodelDeleteNoSQLResourceResponse'
type: 'model'
fields:
'platform_name':
type: 'str'
required: true
'resource_id':
type: 'str'
required: true
'resource_name':
type: 'str'
required: true
'resource_type':
type: 'str'
required: true
'studio_name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_delete_no_sql_resource_response.py'
example: |-
apimodel_delete_no_sql_resource_response = csm_models.ApimodelDeleteNoSQLResourceResponse.create(...)
'ApimodelGetAppImageListV2DataItem@py.csm.mod':
id: 'ApimodelGetAppImageListV2DataItem@py.csm.mod'
name: 'ApimodelGetAppImageListV2DataItem'
type: 'model'
fields:
'image_digest':
type: 'str'
required: true
'image_tag':
type: 'str'
required: true
'is_active':
type: 'bool'
required: true
'size':
type: 'int'
required: true
'image_scan_result':
type: 'ApimodelGetAppImageListV2DataItemImageScanResult'
required: false
'image_scan_status':
type: 'ApimodelGetAppImageListV2DataItemImageScanStatus'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_image_list_v2_data_item.py'
example: |-
apimodel_get_app_image_list_v2_data_item = csm_models.ApimodelGetAppImageListV2DataItem.create(...)
'ApimodelGetAppImageListV2DataItemImageScanResult@py.csm.mod':
id: 'ApimodelGetAppImageListV2DataItemImageScanResult@py.csm.mod'
name: 'ApimodelGetAppImageListV2DataItemImageScanResult'
type: 'model'
fields:
'finding_severity_counts':
type: 'Dict[str, int]'
required: true
'findings':
type: 'List[ModelImageScanFinding]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_image_list_v2_data_item_image_scan_result.py'
example: |-
apimodel_get_app_image_list_v2_data_item_image_scan_result = csm_models.ApimodelGetAppImageListV2DataItemImageScanResult.create(...)
'ApimodelGetAppImageListV2DataItemImageScanStatus@py.csm.mod':
id: 'ApimodelGetAppImageListV2DataItemImageScanStatus@py.csm.mod'
name: 'ApimodelGetAppImageListV2DataItemImageScanStatus'
type: 'model'
fields:
'status':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_image_list_v2_data_item_image_scan_status.py'
example: |-
apimodel_get_app_image_list_v2_data_item_image_scan_status = csm_models.ApimodelGetAppImageListV2DataItemImageScanStatus.create(...)
'ApimodelGetAppImageListV2Response@py.csm.mod':
id: 'ApimodelGetAppImageListV2Response@py.csm.mod'
name: 'ApimodelGetAppImageListV2Response'
type: 'model'
fields:
'data':
type: 'List[ApimodelGetAppImageListV2DataItem]'
required: true
'vulnerability_status':
type: 'str'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_image_list_v2_response.py'
example: |-
apimodel_get_app_image_list_v2_response = csm_models.ApimodelGetAppImageListV2Response.create(...)
'ApimodelGetAppListV2Request@py.csm.mod':
id: 'ApimodelGetAppListV2Request@py.csm.mod'
name: 'ApimodelGetAppListV2Request'
type: 'model'
fields:
'app_names':
type: 'List[str]'
required: false
'app_statuses':
type: 'List[str]'
required: false
'fuzzy_app_name':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_list_v2_request.py'
example: |-
apimodel_get_app_list_v2_request = csm_models.ApimodelGetAppListV2Request.create(...)
'ApimodelGetAppListV2Response@py.csm.mod':
id: 'ApimodelGetAppListV2Response@py.csm.mod'
name: 'ApimodelGetAppListV2Response'
type: 'model'
fields:
'data':
type: 'List[ApimodelAppItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_app_list_v2_response.py'
example: |-
apimodel_get_app_list_v2_response = csm_models.ApimodelGetAppListV2Response.create(...)
'ApimodelGetDeploymentListV2DataItem@py.csm.mod':
id: 'ApimodelGetDeploymentListV2DataItem@py.csm.mod'
name: 'ApimodelGetDeploymentListV2DataItem'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: true
'image_tag':
type: 'str'
required: true
'status':
type: 'str'
required: true
'deleted_at':
type: 'str'
required: false
'message':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_deployment_list_v2_data_item.py'
example: |-
apimodel_get_deployment_list_v2_data_item = csm_models.ApimodelGetDeploymentListV2DataItem.create(...)
'ApimodelGetDeploymentListV2Request@py.csm.mod':
id: 'ApimodelGetDeploymentListV2Request@py.csm.mod'
name: 'ApimodelGetDeploymentListV2Request'
type: 'model'
fields:
'app_ids':
type: 'List[str]'
required: false
'deployment_ids':
type: 'List[str]'
required: false
'statuses':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_deployment_list_v2_request.py'
example: |-
apimodel_get_deployment_list_v2_request = csm_models.ApimodelGetDeploymentListV2Request.create(...)
'ApimodelGetDeploymentListV2Response@py.csm.mod':
id: 'ApimodelGetDeploymentListV2Response@py.csm.mod'
name: 'ApimodelGetDeploymentListV2Response'
type: 'model'
fields:
'data':
type: 'List[ApimodelGetDeploymentListV2DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_deployment_list_v2_response.py'
example: |-
apimodel_get_deployment_list_v2_response = csm_models.ApimodelGetDeploymentListV2Response.create(...)
'ApimodelGetListOfConfigurationsV2DataItem@py.csm.mod':
id: 'ApimodelGetListOfConfigurationsV2DataItem@py.csm.mod'
name: 'ApimodelGetListOfConfigurationsV2DataItem'
type: 'model'
fields:
'config_id':
type: 'str'
required: true
'config_name':
type: 'str'
required: true
'config_type':
type: 'str'
required: true
'deployment_status':
type: 'str'
required: true
'editable':
type: 'bool'
required: true
'is_hidden':
type: 'bool'
required: true
'value':
type: 'str'
required: true
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
'source':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_list_of_configurations_v2_data_item.py'
example: |-
apimodel_get_list_of_configurations_v2_data_item = csm_models.ApimodelGetListOfConfigurationsV2DataItem.create(...)
'ApimodelGetListOfConfigurationsV2Response@py.csm.mod':
id: 'ApimodelGetListOfConfigurationsV2Response@py.csm.mod'
name: 'ApimodelGetListOfConfigurationsV2Response'
type: 'model'
fields:
'data':
type: 'List[ApimodelGetListOfConfigurationsV2DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_list_of_configurations_v2_response.py'
example: |-
apimodel_get_list_of_configurations_v2_response = csm_models.ApimodelGetListOfConfigurationsV2Response.create(...)
'ApimodelGetNotificationSubscriberItem@py.csm.mod':
id: 'ApimodelGetNotificationSubscriberItem@py.csm.mod'
name: 'ApimodelGetNotificationSubscriberItem'
type: 'model'
fields:
'notification_type':
type: 'Dict[str, bool]'
required: true
'subscription_id':
type: 'str'
required: true
'display_name':
type: 'str'
required: false
'email_address':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_notification_subscriber_item.py'
example: |-
apimodel_get_notification_subscriber_item = csm_models.ApimodelGetNotificationSubscriberItem.create(...)
'ApimodelGetNotificationSubscriberItemV2@py.csm.mod':
id: 'ApimodelGetNotificationSubscriberItemV2@py.csm.mod'
name: 'ApimodelGetNotificationSubscriberItemV2'
type: 'model'
fields:
'notification_types':
type: 'List[ApimodelNotificationType]'
required: true
'display_name':
type: 'str'
required: false
'email_address':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_notification_subscriber_item_v2.py'
example: |-
apimodel_get_notification_subscriber_item_v2 = csm_models.ApimodelGetNotificationSubscriberItemV2.create(...)
'ApimodelGetNotificationSubscriberListResponse@py.csm.mod':
id: 'ApimodelGetNotificationSubscriberListResponse@py.csm.mod'
name: 'ApimodelGetNotificationSubscriberListResponse'
type: 'model'
fields:
'max_subscriptions':
type: 'int'
required: true
'subscriptions':
type: 'List[ApimodelGetNotificationSubscriberItem]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_notification_subscriber_list_response.py'
example: |-
apimodel_get_notification_subscriber_list_response = csm_models.ApimodelGetNotificationSubscriberListResponse.create(...)
'ApimodelGetNotificationSubscriberListResponseV2@py.csm.mod':
id: 'ApimodelGetNotificationSubscriberListResponseV2@py.csm.mod'
name: 'ApimodelGetNotificationSubscriberListResponseV2'
type: 'model'
fields:
'max_subscriptions':
type: 'int'
required: true
'subscriptions':
type: 'List[ApimodelGetNotificationSubscriberItemV2]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_notification_subscriber_list_response_v2.py'
example: |-
apimodel_get_notification_subscriber_list_response_v2 = csm_models.ApimodelGetNotificationSubscriberListResponseV2.create(...)
'ApimodelGetNotificationSubscriberStatusResponse@py.csm.mod':
id: 'ApimodelGetNotificationSubscriberStatusResponse@py.csm.mod'
name: 'ApimodelGetNotificationSubscriberStatusResponse'
type: 'model'
fields:
'max_subscription':
type: 'int'
required: true
'notification_type':
type: 'str'
required: true
'subscribed':
type: 'bool'
required: true
'subscriptions_count':
type: 'int'
required: true
'display_name':
type: 'str'
required: false
'email_address':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_get_notification_subscriber_status_response.py'
example: |-
apimodel_get_notification_subscriber_status_response = csm_models.ApimodelGetNotificationSubscriberStatusResponse.create(...)
'ApimodelIncreaseLimitFormRequest@py.csm.mod':
id: 'ApimodelIncreaseLimitFormRequest@py.csm.mod'
name: 'ApimodelIncreaseLimitFormRequest'
type: 'model'
fields:
'client_email':
type: 'str'
required: true
'request_reason':
type: 'str'
required: true
'preferred_limit_replica':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_increase_limit_form_request.py'
example: |-
apimodel_increase_limit_form_request = csm_models.ApimodelIncreaseLimitFormRequest.create(...)
'ApimodelListTopicsResponse@py.csm.mod':
id: 'ApimodelListTopicsResponse@py.csm.mod'
name: 'ApimodelListTopicsResponse'
type: 'model'
fields:
'data':
type: 'List[ApimodelTopicDetailResponse]'
required: true
'pagination':
type: 'ApimodelPaginationResponse'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_list_topics_response.py'
example: |-
apimodel_list_topics_response = csm_models.ApimodelListTopicsResponse.create(...)
'ApimodelMemoryRequest@py.csm.mod':
id: 'ApimodelMemoryRequest@py.csm.mod'
name: 'ApimodelMemoryRequest'
type: 'model'
fields:
'request_memory':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_memory_request.py'
example: |-
apimodel_memory_request = csm_models.ApimodelMemoryRequest.create(...)
'ApimodelMemoryResponse@py.csm.mod':
id: 'ApimodelMemoryResponse@py.csm.mod'
name: 'ApimodelMemoryResponse'
type: 'model'
fields:
'memory_limit':
type: 'int'
required: false
'request_memory':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_memory_response.py'
example: |-
apimodel_memory_response = csm_models.ApimodelMemoryResponse.create(...)
'ApimodelNoSQLDatabaseCredentialResponse@py.csm.mod':
id: 'ApimodelNoSQLDatabaseCredentialResponse@py.csm.mod'
name: 'ApimodelNoSQLDatabaseCredentialResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'owner':
type: 'str'
required: true
'username':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_no_sql_database_credential_response.py'
example: |-
apimodel_no_sql_database_credential_response = csm_models.ApimodelNoSQLDatabaseCredentialResponse.create(...)
'ApimodelNoSQLDatabaseDeleteResponse@py.csm.mod':
id: 'ApimodelNoSQLDatabaseDeleteResponse@py.csm.mod'
name: 'ApimodelNoSQLDatabaseDeleteResponse'
type: 'model'
fields:
'db_id':
type: 'str'
required: true
'db_name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_no_sql_database_delete_response.py'
example: |-
apimodel_no_sql_database_delete_response = csm_models.ApimodelNoSQLDatabaseDeleteResponse.create(...)
'ApimodelNoSQLDatabaseResponse@py.csm.mod':
id: 'ApimodelNoSQLDatabaseResponse@py.csm.mod'
name: 'ApimodelNoSQLDatabaseResponse'
type: 'model'
fields:
'app_id':
type: 'str'
required: true
'credentials':
type: 'ApimodelNoSQLDatabaseCredentialResponse'
required: true
'db_id':
type: 'str'
required: true
'db_name':
type: 'str'
required: true
'game_namespace':
type: 'str'
required: true
'hostnames':
type: 'str'
required: true
'platform_name':
type: 'str'
required: true
'resource_id':
type: 'str'
required: true
'resource_status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_no_sql_database_response.py'
example: |-
apimodel_no_sql_database_response = csm_models.ApimodelNoSQLDatabaseResponse.create(...)
'ApimodelNoSQLResourceResponse@py.csm.mod':
id: 'ApimodelNoSQLResourceResponse@py.csm.mod'
name: 'ApimodelNoSQLResourceResponse'
type: 'model'
fields:
'platform_name':
type: 'str'
required: true
'resource_id':
type: 'str'
required: true
'resource_name':
type: 'str'
required: true
'resource_type':
type: 'str'
required: true
'status':
type: 'str'
required: true
'studio_name':
type: 'str'
required: true
'configuration':
type: 'NosqlresourceNoSQLResourceConfiguration'
required: false
'hostnames':
type: 'str'
required: false
'last_rotated_at':
type: 'str'
required: false
'region':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_no_sql_resource_response.py'
example: |-
apimodel_no_sql_resource_response = csm_models.ApimodelNoSQLResourceResponse.create(...)
'ApimodelNotificationType@py.csm.mod':
id: 'ApimodelNotificationType@py.csm.mod'
name: 'ApimodelNotificationType'
type: 'model'
fields:
'subcription_id':
type: 'str'
required: true
'type_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_notification_type.py'
example: |-
apimodel_notification_type = csm_models.ApimodelNotificationType.create(...)
'ApimodelPaginationResponse@py.csm.mod':
id: 'ApimodelPaginationResponse@py.csm.mod'
name: 'ApimodelPaginationResponse'
type: 'model'
fields:
'total_data':
type: 'int'
required: true
'first':
type: 'str'
required: false
'last':
type: 'str'
required: false
'next_':
type: 'str'
required: false
'previous':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_pagination_response.py'
example: |-
apimodel_pagination_response = csm_models.ApimodelPaginationResponse.create(...)
'ApimodelReplicaRequest@py.csm.mod':
id: 'ApimodelReplicaRequest@py.csm.mod'
name: 'ApimodelReplicaRequest'
type: 'model'
fields:
'max_replica':
type: 'int'
required: false
'min_replica':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_replica_request.py'
example: |-
apimodel_replica_request = csm_models.ApimodelReplicaRequest.create(...)
'ApimodelReplicaResponse@py.csm.mod':
id: 'ApimodelReplicaResponse@py.csm.mod'
name: 'ApimodelReplicaResponse'
type: 'model'
fields:
'current_replica':
type: 'int'
required: false
'max_replica':
type: 'int'
required: false
'min_replica':
type: 'int'
required: false
'replica_limit':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_replica_response.py'
example: |-
apimodel_replica_response = csm_models.ApimodelReplicaResponse.create(...)
'ApimodelSaveConfigurationV2Request@py.csm.mod':
id: 'ApimodelSaveConfigurationV2Request@py.csm.mod'
name: 'ApimodelSaveConfigurationV2Request'
type: 'model'
fields:
'config_name':
type: 'str'
required: true
'source':
type: 'str'
required: true
'value':
type: 'str'
required: true
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_save_configuration_v2_request.py'
example: |-
apimodel_save_configuration_v2_request = csm_models.ApimodelSaveConfigurationV2Request.create(...)
'ApimodelSaveConfigurationV2Response@py.csm.mod':
id: 'ApimodelSaveConfigurationV2Response@py.csm.mod'
name: 'ApimodelSaveConfigurationV2Response'
type: 'model'
fields:
'config_id':
type: 'str'
required: true
'config_name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_save_configuration_v2_response.py'
example: |-
apimodel_save_configuration_v2_response = csm_models.ApimodelSaveConfigurationV2Response.create(...)
'ApimodelSaveSecretConfigurationV2Request@py.csm.mod':
id: 'ApimodelSaveSecretConfigurationV2Request@py.csm.mod'
name: 'ApimodelSaveSecretConfigurationV2Request'
type: 'model'
fields:
'config_name':
type: 'str'
required: true
'source':
type: 'str'
required: true
'value':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_save_secret_configuration_v2_request.py'
example: |-
apimodel_save_secret_configuration_v2_request = csm_models.ApimodelSaveSecretConfigurationV2Request.create(...)
'ApimodelSelfSubscribeNotificationRequest@py.csm.mod':
id: 'ApimodelSelfSubscribeNotificationRequest@py.csm.mod'
name: 'ApimodelSelfSubscribeNotificationRequest'
type: 'model'
fields:
'notification_type':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_self_subscribe_notification_request.py'
example: |-
apimodel_self_subscribe_notification_request = csm_models.ApimodelSelfSubscribeNotificationRequest.create(...)
'ApimodelSubscribeNotificationRequest@py.csm.mod':
id: 'ApimodelSubscribeNotificationRequest@py.csm.mod'
name: 'ApimodelSubscribeNotificationRequest'
type: 'model'
fields:
'notification_type':
type: 'str'
required: true
'subscribers':
type: 'List[ApimodelSubscriberItemRequest]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_subscribe_notification_request.py'
example: |-
apimodel_subscribe_notification_request = csm_models.ApimodelSubscribeNotificationRequest.create(...)
'ApimodelSubscribeNotificationResponse@py.csm.mod':
id: 'ApimodelSubscribeNotificationResponse@py.csm.mod'
name: 'ApimodelSubscribeNotificationResponse'
type: 'model'
fields:
'notification_type':
type: 'str'
required: true
'subscriptions':
type: 'List[ApimodelSubscriberItemResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_subscribe_notification_response.py'
example: |-
apimodel_subscribe_notification_response = csm_models.ApimodelSubscribeNotificationResponse.create(...)
'ApimodelSubscriberItemRequest@py.csm.mod':
id: 'ApimodelSubscriberItemRequest@py.csm.mod'
name: 'ApimodelSubscriberItemRequest'
type: 'model'
fields:
'email_address':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_subscriber_item_request.py'
example: |-
apimodel_subscriber_item_request = csm_models.ApimodelSubscriberItemRequest.create(...)
'ApimodelSubscriberItemResponse@py.csm.mod':
id: 'ApimodelSubscriberItemResponse@py.csm.mod'
name: 'ApimodelSubscriberItemResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'display_name':
type: 'str'
required: false
'email_address':
type: 'str'
required: false
'notification_type':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_subscriber_item_response.py'
example: |-
apimodel_subscriber_item_response = csm_models.ApimodelSubscriberItemResponse.create(...)
'ApimodelTopicDetailResponse@py.csm.mod':
id: 'ApimodelTopicDetailResponse@py.csm.mod'
name: 'ApimodelTopicDetailResponse'
type: 'model'
fields:
'game_name':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'region':
type: 'str'
required: true
'studio_name':
type: 'str'
required: true
'topic_arn':
type: 'str'
required: true
'topic_name':
type: 'str'
required: true
'description':
type: 'str'
required: false
'subscribers':
type: 'List[ApimodelTopicSubscription]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_topic_detail_response.py'
example: |-
apimodel_topic_detail_response = csm_models.ApimodelTopicDetailResponse.create(...)
'ApimodelTopicResponse@py.csm.mod':
id: 'ApimodelTopicResponse@py.csm.mod'
name: 'ApimodelTopicResponse'
type: 'model'
fields:
'game_name':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'region':
type: 'str'
required: true
'studio_name':
type: 'str'
required: true
'topic_arn':
type: 'str'
required: true
'topic_name':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_topic_response.py'
example: |-
apimodel_topic_response = csm_models.ApimodelTopicResponse.create(...)
'ApimodelTopicSubscription@py.csm.mod':
id: 'ApimodelTopicSubscription@py.csm.mod'
name: 'ApimodelTopicSubscription'
type: 'model'
fields:
'app_id':
type: 'str'
required: true
'app_name':
type: 'str'
required: true
'queue_id':
type: 'str'
required: true
'subscription_arn':
type: 'str'
required: true
'subscription_id':
type: 'str'
required: true
'subscription_time':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_topic_subscription.py'
example: |-
apimodel_topic_subscription = csm_models.ApimodelTopicSubscription.create(...)
'ApimodelTunnelInfoResponse@py.csm.mod':
id: 'ApimodelTunnelInfoResponse@py.csm.mod'
name: 'ApimodelTunnelInfoResponse'
type: 'model'
fields:
'tunnel':
type: 'ResourceaccesstunnelTunnelInfo'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_tunnel_info_response.py'
example: |-
apimodel_tunnel_info_response = csm_models.ApimodelTunnelInfoResponse.create(...)
'ApimodelUpdateAppResourceRequest@py.csm.mod':
id: 'ApimodelUpdateAppResourceRequest@py.csm.mod'
name: 'ApimodelUpdateAppResourceRequest'
type: 'model'
fields:
'autoscaling':
type: 'ApimodelAutoscalingRequest'
required: true
'cpu':
type: 'ApimodelCPURequest'
required: false
'memory':
type: 'ApimodelMemoryRequest'
required: false
'replica':
type: 'ApimodelReplicaRequest'
required: false
'vm_sharing_configuration':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_update_app_resource_request.py'
example: |-
apimodel_update_app_resource_request = csm_models.ApimodelUpdateAppResourceRequest.create(...)
'ApimodelUpdateAppV2Request@py.csm.mod':
id: 'ApimodelUpdateAppV2Request@py.csm.mod'
name: 'ApimodelUpdateAppV2Request'
type: 'model'
fields:
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_update_app_v2_request.py'
example: |-
apimodel_update_app_v2_request = csm_models.ApimodelUpdateAppV2Request.create(...)
'ApimodelUpdateConfigurationV2Request@py.csm.mod':
id: 'ApimodelUpdateConfigurationV2Request@py.csm.mod'
name: 'ApimodelUpdateConfigurationV2Request'
type: 'model'
fields:
'value':
type: 'str'
required: true
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_update_configuration_v2_request.py'
example: |-
apimodel_update_configuration_v2_request = csm_models.ApimodelUpdateConfigurationV2Request.create(...)
'ApimodelUpdateConfigurationV2Response@py.csm.mod':
id: 'ApimodelUpdateConfigurationV2Response@py.csm.mod'
name: 'ApimodelUpdateConfigurationV2Response'
type: 'model'
fields:
'config_id':
type: 'str'
required: true
'config_name':
type: 'str'
required: true
'value':
type: 'str'
required: true
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
'source':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_update_configuration_v2_response.py'
example: |-
apimodel_update_configuration_v2_response = csm_models.ApimodelUpdateConfigurationV2Response.create(...)
'ApimodelUpdateSecretConfigurationV2Request@py.csm.mod':
id: 'ApimodelUpdateSecretConfigurationV2Request@py.csm.mod'
name: 'ApimodelUpdateSecretConfigurationV2Request'
type: 'model'
fields:
'value':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/apimodel_update_secret_configuration_v2_request.py'
example: |-
apimodel_update_secret_configuration_v2_request = csm_models.ApimodelUpdateSecretConfigurationV2Request.create(...)
'GeneratedCreateAppV1Request@py.csm.mod':
id: 'GeneratedCreateAppV1Request@py.csm.mod'
name: 'GeneratedCreateAppV1Request'
type: 'model'
fields:
'description':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_create_app_v1_request.py'
example: |-
generated_create_app_v1_request = csm_models.GeneratedCreateAppV1Request.create(...)
'GeneratedCreateAppV1Response@py.csm.mod':
id: 'GeneratedCreateAppV1Response@py.csm.mod'
name: 'GeneratedCreateAppV1Response'
type: 'model'
fields:
'status_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_create_app_v1_response.py'
example: |-
generated_create_app_v1_response = csm_models.GeneratedCreateAppV1Response.create(...)
'GeneratedCreateDeploymentV1Request@py.csm.mod':
id: 'GeneratedCreateDeploymentV1Request@py.csm.mod'
name: 'GeneratedCreateDeploymentV1Request'
type: 'model'
fields:
'image_tag':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_create_deployment_v1_request.py'
example: |-
generated_create_deployment_v1_request = csm_models.GeneratedCreateDeploymentV1Request.create(...)
'GeneratedCreateDeploymentV1Response@py.csm.mod':
id: 'GeneratedCreateDeploymentV1Response@py.csm.mod'
name: 'GeneratedCreateDeploymentV1Response'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_create_deployment_v1_response.py'
example: |-
generated_create_deployment_v1_response = csm_models.GeneratedCreateDeploymentV1Response.create(...)
'GeneratedDeleteAppImagesV1Request@py.csm.mod':
id: 'GeneratedDeleteAppImagesV1Request@py.csm.mod'
name: 'GeneratedDeleteAppImagesV1Request'
type: 'model'
fields:
'image_tags':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_delete_app_images_v1_request.py'
example: |-
generated_delete_app_images_v1_request = csm_models.GeneratedDeleteAppImagesV1Request.create(...)
'GeneratedGetAppImageListV1DataItem@py.csm.mod':
id: 'GeneratedGetAppImageListV1DataItem@py.csm.mod'
name: 'GeneratedGetAppImageListV1DataItem'
type: 'model'
fields:
'image_digest':
type: 'str'
required: true
'image_tag':
type: 'str'
required: true
'image_scan_status':
type: 'GeneratedGetAppImageListV1DataItemImageScanStatus'
required: false
'size':
type: 'int'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_image_list_v1_data_item.py'
example: |-
generated_get_app_image_list_v1_data_item = csm_models.GeneratedGetAppImageListV1DataItem.create(...)
'GeneratedGetAppImageListV1DataItemImageScanStatus@py.csm.mod':
id: 'GeneratedGetAppImageListV1DataItemImageScanStatus@py.csm.mod'
name: 'GeneratedGetAppImageListV1DataItemImageScanStatus'
type: 'model'
fields:
'description':
type: 'str'
required: false
'status':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_image_list_v1_data_item_image_scan_status.py'
example: |-
generated_get_app_image_list_v1_data_item_image_scan_status = csm_models.GeneratedGetAppImageListV1DataItemImageScanStatus.create(...)
'GeneratedGetAppImageListV1Response@py.csm.mod':
id: 'GeneratedGetAppImageListV1Response@py.csm.mod'
name: 'GeneratedGetAppImageListV1Response'
type: 'model'
fields:
'data':
type: 'List[GeneratedGetAppImageListV1DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_image_list_v1_response.py'
example: |-
generated_get_app_image_list_v1_response = csm_models.GeneratedGetAppImageListV1Response.create(...)
'GeneratedGetAppListV1DataItem@py.csm.mod':
id: 'GeneratedGetAppListV1DataItem@py.csm.mod'
name: 'GeneratedGetAppListV1DataItem'
type: 'model'
fields:
'deployment_created_at':
type: 'str'
required: true
'deployment_id':
type: 'str'
required: true
'deployment_image_tag':
type: 'str'
required: true
'app_id':
type: 'str'
required: false
'app_name':
type: 'str'
required: false
'app_release_status':
type: 'str'
required: false
'app_repo_arn':
type: 'str'
required: false
'app_repo_url':
type: 'str'
required: false
'app_status':
type: 'str'
required: false
'base_path':
type: 'str'
required: false
'deleted_at':
type: 'str'
required: false
'deployment_status':
type: 'str'
required: false
'description':
type: 'str'
required: false
'message':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
'service_public_url':
type: 'str'
required: false
'service_url':
type: 'str'
required: false
'status':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_list_v1_data_item.py'
example: |-
generated_get_app_list_v1_data_item = csm_models.GeneratedGetAppListV1DataItem.create(...)
'GeneratedGetAppListV1Request@py.csm.mod':
id: 'GeneratedGetAppListV1Request@py.csm.mod'
name: 'GeneratedGetAppListV1Request'
type: 'model'
fields:
'app_names':
type: 'List[str]'
required: true
'statuses':
type: 'List[str]'
required: true
'fuzzy_app_name':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_list_v1_request.py'
example: |-
generated_get_app_list_v1_request = csm_models.GeneratedGetAppListV1Request.create(...)
'GeneratedGetAppListV1Response@py.csm.mod':
id: 'GeneratedGetAppListV1Response@py.csm.mod'
name: 'GeneratedGetAppListV1Response'
type: 'model'
fields:
'data':
type: 'List[GeneratedGetAppListV1DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_list_v1_response.py'
example: |-
generated_get_app_list_v1_response = csm_models.GeneratedGetAppListV1Response.create(...)
'GeneratedGetAppReleaseV1Response@py.csm.mod':
id: 'GeneratedGetAppReleaseV1Response@py.csm.mod'
name: 'GeneratedGetAppReleaseV1Response'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: false
'image_tag':
type: 'str'
required: false
'release_date':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_release_v1_response.py'
example: |-
generated_get_app_release_v1_response = csm_models.GeneratedGetAppReleaseV1Response.create(...)
'GeneratedGetAppV1Response@py.csm.mod':
id: 'GeneratedGetAppV1Response@py.csm.mod'
name: 'GeneratedGetAppV1Response'
type: 'model'
fields:
'deployment_created_at':
type: 'str'
required: true
'deployment_id':
type: 'str'
required: true
'deployment_image_tag':
type: 'str'
required: true
'app_id':
type: 'str'
required: false
'app_name':
type: 'str'
required: false
'app_release_status':
type: 'str'
required: false
'app_repo_arn':
type: 'str'
required: false
'app_repo_url':
type: 'str'
required: false
'app_status':
type: 'str'
required: false
'base_path':
type: 'str'
required: false
'created_at':
type: 'str'
required: false
'deleted_at':
type: 'str'
required: false
'deployment_status':
type: 'str'
required: false
'description':
type: 'str'
required: false
'message':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
'service_public_url':
type: 'str'
required: false
'service_url':
type: 'str'
required: false
'status':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_app_v1_response.py'
example: |-
generated_get_app_v1_response = csm_models.GeneratedGetAppV1Response.create(...)
'GeneratedGetDeploymentListV1DataItem@py.csm.mod':
id: 'GeneratedGetDeploymentListV1DataItem@py.csm.mod'
name: 'GeneratedGetDeploymentListV1DataItem'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: true
'deleted_at':
type: 'str'
required: false
'image_tag':
type: 'str'
required: false
'message':
type: 'str'
required: false
'status':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_deployment_list_v1_data_item.py'
example: |-
generated_get_deployment_list_v1_data_item = csm_models.GeneratedGetDeploymentListV1DataItem.create(...)
'GeneratedGetDeploymentListV1Request@py.csm.mod':
id: 'GeneratedGetDeploymentListV1Request@py.csm.mod'
name: 'GeneratedGetDeploymentListV1Request'
type: 'model'
fields:
'app_ids':
type: 'List[str]'
required: true
'deployment_ids':
type: 'List[str]'
required: true
'statuses':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_deployment_list_v1_request.py'
example: |-
generated_get_deployment_list_v1_request = csm_models.GeneratedGetDeploymentListV1Request.create(...)
'GeneratedGetDeploymentListV1Response@py.csm.mod':
id: 'GeneratedGetDeploymentListV1Response@py.csm.mod'
name: 'GeneratedGetDeploymentListV1Response'
type: 'model'
fields:
'data':
type: 'List[GeneratedGetDeploymentListV1DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_deployment_list_v1_response.py'
example: |-
generated_get_deployment_list_v1_response = csm_models.GeneratedGetDeploymentListV1Response.create(...)
'GeneratedGetDeploymentV1Response@py.csm.mod':
id: 'GeneratedGetDeploymentV1Response@py.csm.mod'
name: 'GeneratedGetDeploymentV1Response'
type: 'model'
fields:
'deployment_id':
type: 'str'
required: true
'deleted_at':
type: 'str'
required: false
'image_tag':
type: 'str'
required: false
'message':
type: 'str'
required: false
'status':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_deployment_v1_response.py'
example: |-
generated_get_deployment_v1_response = csm_models.GeneratedGetDeploymentV1Response.create(...)
'GeneratedGetListOfConfigurationsV1DataItem@py.csm.mod':
id: 'GeneratedGetListOfConfigurationsV1DataItem@py.csm.mod'
name: 'GeneratedGetListOfConfigurationsV1DataItem'
type: 'model'
fields:
'apply_mask':
type: 'bool'
required: false
'config_id':
type: 'str'
required: false
'config_name':
type: 'str'
required: false
'config_type':
type: 'str'
required: false
'deployment_status':
type: 'str'
required: false
'description':
type: 'str'
required: false
'editable':
type: 'bool'
required: false
'is_hidden':
type: 'bool'
required: false
'source':
type: 'str'
required: false
'value':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_list_of_configurations_v1_data_item.py'
example: |-
generated_get_list_of_configurations_v1_data_item = csm_models.GeneratedGetListOfConfigurationsV1DataItem.create(...)
'GeneratedGetListOfConfigurationsV1Response@py.csm.mod':
id: 'GeneratedGetListOfConfigurationsV1Response@py.csm.mod'
name: 'GeneratedGetListOfConfigurationsV1Response'
type: 'model'
fields:
'data':
type: 'List[GeneratedGetListOfConfigurationsV1DataItem]'
required: true
'paging':
type: 'GeneratedPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_get_list_of_configurations_v1_response.py'
example: |-
generated_get_list_of_configurations_v1_response = csm_models.GeneratedGetListOfConfigurationsV1Response.create(...)
'GeneratedPagination@py.csm.mod':
id: 'GeneratedPagination@py.csm.mod'
name: 'GeneratedPagination'
type: 'model'
fields:
'first':
type: 'str'
required: false
'last':
type: 'str'
required: false
'next_':
type: 'str'
required: false
'previous':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_pagination.py'
example: |-
generated_pagination = csm_models.GeneratedPagination.create(...)
'GeneratedSaveConfigurationV1Request@py.csm.mod':
id: 'GeneratedSaveConfigurationV1Request@py.csm.mod'
name: 'GeneratedSaveConfigurationV1Request'
type: 'model'
fields:
'config_name':
type: 'str'
required: true
'source':
type: 'str'
required: true
'value':
type: 'str'
required: true
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_save_configuration_v1_request.py'
example: |-
generated_save_configuration_v1_request = csm_models.GeneratedSaveConfigurationV1Request.create(...)
'GeneratedSaveConfigurationV1Response@py.csm.mod':
id: 'GeneratedSaveConfigurationV1Response@py.csm.mod'
name: 'GeneratedSaveConfigurationV1Response'
type: 'model'
fields:
'config_id':
type: 'str'
required: true
'config_name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_save_configuration_v1_response.py'
example: |-
generated_save_configuration_v1_response = csm_models.GeneratedSaveConfigurationV1Response.create(...)
'GeneratedStartAppV1Request@py.csm.mod':
id: 'GeneratedStartAppV1Request@py.csm.mod'
name: 'GeneratedStartAppV1Request'
type: 'model'
fields:
'reason':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_start_app_v1_request.py'
example: |-
generated_start_app_v1_request = csm_models.GeneratedStartAppV1Request.create(...)
'GeneratedStartAppV1Response@py.csm.mod':
id: 'GeneratedStartAppV1Response@py.csm.mod'
name: 'GeneratedStartAppV1Response'
type: 'model'
fields:
'status_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_start_app_v1_response.py'
example: |-
generated_start_app_v1_response = csm_models.GeneratedStartAppV1Response.create(...)
'GeneratedStopAppV1Request@py.csm.mod':
id: 'GeneratedStopAppV1Request@py.csm.mod'
name: 'GeneratedStopAppV1Request'
type: 'model'
fields:
'reason':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_stop_app_v1_request.py'
example: |-
generated_stop_app_v1_request = csm_models.GeneratedStopAppV1Request.create(...)
'GeneratedStopAppV1Response@py.csm.mod':
id: 'GeneratedStopAppV1Response@py.csm.mod'
name: 'GeneratedStopAppV1Response'
type: 'model'
fields:
'status_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_stop_app_v1_response.py'
example: |-
generated_stop_app_v1_response = csm_models.GeneratedStopAppV1Response.create(...)
'GeneratedUpdateAppV1Request@py.csm.mod':
id: 'GeneratedUpdateAppV1Request@py.csm.mod'
name: 'GeneratedUpdateAppV1Request'
type: 'model'
fields:
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_update_app_v1_request.py'
example: |-
generated_update_app_v1_request = csm_models.GeneratedUpdateAppV1Request.create(...)
'GeneratedUpdateAppV1Response@py.csm.mod':
id: 'GeneratedUpdateAppV1Response@py.csm.mod'
name: 'GeneratedUpdateAppV1Response'
type: 'model'
fields:
'app_id':
type: 'str'
required: false
'app_name':
type: 'str'
required: false
'app_repo_arn':
type: 'str'
required: false
'app_repo_url':
type: 'str'
required: false
'deleted_at':
type: 'str'
required: false
'description':
type: 'str'
required: false
'message':
type: 'str'
required: false
'scenario':
type: 'str'
required: false
'service_url':
type: 'str'
required: false
'status':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_update_app_v1_response.py'
example: |-
generated_update_app_v1_response = csm_models.GeneratedUpdateAppV1Response.create(...)
'GeneratedUpdateConfigurationV1Request@py.csm.mod':
id: 'GeneratedUpdateConfigurationV1Request@py.csm.mod'
name: 'GeneratedUpdateConfigurationV1Request'
type: 'model'
fields:
'apply_mask':
type: 'bool'
required: false
'description':
type: 'str'
required: false
'value':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_update_configuration_v1_request.py'
example: |-
generated_update_configuration_v1_request = csm_models.GeneratedUpdateConfigurationV1Request.create(...)
'GeneratedUpdateConfigurationV1Response@py.csm.mod':
id: 'GeneratedUpdateConfigurationV1Response@py.csm.mod'
name: 'GeneratedUpdateConfigurationV1Response'
type: 'model'
fields:
'apply_mask':
type: 'bool'
required: false
'config_id':
type: 'str'
required: false
'config_name':
type: 'str'
required: false
'description':
type: 'str'
required: false
'source':
type: 'str'
required: false
'value':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/generated_update_configuration_v1_response.py'
example: |-
generated_update_configuration_v1_response = csm_models.GeneratedUpdateConfigurationV1Response.create(...)
'LogAppMessageDeclaration@py.csm.mod':
id: 'LogAppMessageDeclaration@py.csm.mod'
name: 'LogAppMessageDeclaration'
type: 'model'
fields:
'attributes':
type: 'List[str]'
required: true
'code':
type: 'str'
required: true
'code_name':
type: 'str'
required: true
'section':
type: 'str'
required: true
'service':
type: 'str'
required: true
'text':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/log_app_message_declaration.py'
example: |-
log_app_message_declaration = csm_models.LogAppMessageDeclaration.create(...)
'ModelAppRedeploymentDetail@py.csm.mod':
id: 'ModelAppRedeploymentDetail@py.csm.mod'
name: 'ModelAppRedeploymentDetail'
type: 'model'
fields:
'reason_id':
type: 'str'
required: true
'message':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/model_app_redeployment_detail.py'
example: |-
model_app_redeployment_detail = csm_models.ModelAppRedeploymentDetail.create(...)
'ModelAppRedeploymentInfo@py.csm.mod':
id: 'ModelAppRedeploymentInfo@py.csm.mod'
name: 'ModelAppRedeploymentInfo'
type: 'model'
fields:
'should_redeploy':
type: 'bool'
required: true
'details':
type: 'List[ModelAppRedeploymentDetail]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/model_app_redeployment_info.py'
example: |-
model_app_redeployment_info = csm_models.ModelAppRedeploymentInfo.create(...)
'ModelCSMAutoscalingDefaults@py.csm.mod':
id: 'ModelCSMAutoscalingDefaults@py.csm.mod'
name: 'ModelCSMAutoscalingDefaults'
type: 'model'
fields:
'cpu_utilization_default_percent':
type: 'int'
required: true
'cpu_utilization_max_percent':
type: 'int'
required: true
'cpu_utilization_min_percent':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/model_csm_autoscaling_defaults.py'
example: |-
model_csm_autoscaling_defaults = csm_models.ModelCSMAutoscalingDefaults.create(...)
'ModelImageScanFinding@py.csm.mod':
id: 'ModelImageScanFinding@py.csm.mod'
name: 'ModelImageScanFinding'
type: 'model'
fields:
'name':
type: 'str'
required: true
'severity':
type: 'str'
required: true
'uri':
type: 'str'
required: true
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/model_image_scan_finding.py'
example: |-
model_image_scan_finding = csm_models.ModelImageScanFinding.create(...)
'NosqlresourceNoSQLResourceConfiguration@py.csm.mod':
id: 'NosqlresourceNoSQLResourceConfiguration@py.csm.mod'
name: 'NosqlresourceNoSQLResourceConfiguration'
type: 'model'
fields:
'max_dcu':
type: 'float'
required: true
'min_dcu':
type: 'float'
required: true
'profile_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/nosqlresource_no_sql_resource_configuration.py'
example: |-
nosqlresource_no_sql_resource_configuration = csm_models.NosqlresourceNoSQLResourceConfiguration.create(...)
'ResourceaccesstunnelTunnelInfo@py.csm.mod':
id: 'ResourceaccesstunnelTunnelInfo@py.csm.mod'
name: 'ResourceaccesstunnelTunnelInfo'
type: 'model'
fields:
'endpoint':
type: 'str'
required: true
'name':
type: 'str'
required: true
'token':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/resourceaccesstunnel_tunnel_info.py'
example: |-
resourceaccesstunnel_tunnel_info = csm_models.ResourceaccesstunnelTunnelInfo.create(...)
'ResponseErrorResponse@py.csm.mod':
id: 'ResponseErrorResponse@py.csm.mod'
name: 'ResponseErrorResponse'
type: 'model'
fields:
'error':
type: 'str'
required: true
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
'errors':
type: 'str'
required: true
'message_variables':
type: 'Dict[str, str]'
required: true
'name':
type: 'str'
required: true
'reason':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/models/response_error_response.py'
example: |-
response_error_response = csm_models.ResponseErrorResponse.create(...)
# endregion models
# region functions
'bulk_save_subscription_app_notification_v2@py.csm.fun':
id: 'bulk_save_subscription_app_notification_v2@py.csm.fun'
name: 'bulk_save_subscription_app_notification_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [UPDATE]`
Bulk update of users subscribed to an app's notifications.
Request body:
- notificationType : type of the app notification to be subscribed - Required.
- values:
- "all"
- "app-down"
- "critical-vulnerability"
- subscribers : user(s) notification subscription to be updated - Required.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelBulkSubscribeRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelGetNotificationSubscriberListResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/bulk_save_subscription__e5ef74.py'
example: |-
result, error = csm.bulk_save_subscription_app_notification_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'bulk'
- 'notification'
- 'save'
- 'subscription'
- 'v2'
'create_app_v1@py.csm.fun':
id: 'create_app_v1@py.csm.fun'
name: 'create_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [CREATE]`
Creates new App for AB-Extend Customers
Available scenario:
- scenario 3: `event-handler`
- scenario 1: `function-override`
- scenario 2: `service-extension`
Default: `function-override`
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'GeneratedCreateAppV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedCreateAppV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/create_app_v1.py'
example: |-
result, error = csm.create_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'create'
- 'v1'
'create_app_v2@py.csm.fun':
id: 'create_app_v2@py.csm.fun'
name: 'create_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [CREATE]`
Create new extend app with name provided by {app} path parameter and specified scenario type
Available scenario:
- scenario 1: `function-override`
- scenario 2: `service-extension`
- scenario 3: `event-handler`
Available app status:
- `app-creating`
- `app-creation-failed`
- `app-creation-timeout`
- `app-undeployed`
- `deployment-in-progress`
- `deployment-failed`
- `deployment-timeout`
- `deployment-running`
- `deployment-down`
- `app-stopping`
- `app-stop-failed`
- `app-stop-timeout`
- `app-stopped`
- `app-removing`
- `app-removed`
- `app-remove-timeout`
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'ApimodelCreateAppV2Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelAppItem], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/create_app_v2.py'
example: |-
result, error = csm.create_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'create'
- 'v2'
'create_deployment_v1@py.csm.fun':
id: 'create_deployment_v1@py.csm.fun'
name: 'create_deployment_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [CREATE]`
Creates Deployment for extend service
This endpoint intended to apply the helm release or deploying the custom service image.
Logic in this endpoint:
- Getting the repo from AppHistory table and image tag from request
- Getting the Helm Manifest template from S3
- Filling the Helm Manifest values
- Installing the Helm Manifest to deploy the custom service image into K8s based on given namespace
- Storing the filled Helm Manifest to S3
- Storing the Deployment information to Database
Required: Valid Access Token
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedCreateDeploymentV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedCreateDeploymentV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment/create_deployment_v1.py'
example: |-
result, error = csm.create_deployment_v1(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'deployment'
- 'v1'
'create_deployment_v2@py.csm.fun':
id: 'create_deployment_v2@py.csm.fun'
name: 'create_deployment_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [CREATE]`
Creates Deployment for extend service
This Endpoint will create new deployment and apply all of the secrets and variable as environment variable
Required:
- Valid Access Token
- Valid Image Version Created on Uploading image with docker or other method
- Valid App name
- Valid Namespace name
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelCreateDeploymentV2Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelCreateDeploymentV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment_v2/create_deployment_v2.py'
example: |-
result, error = csm.create_deployment_v2(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'deployment'
- 'v2'
'create_no_sql_cluster_v2@py.csm.fun':
id: 'create_no_sql_cluster_v2@py.csm.fun'
name: 'create_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [CREATE]`
Provision NoSQL database cluster and instances that can be used by extend apps in game namespace within the studio.
Only one NoSQL resource can be created for one studio/publisher namespace.
Provisioning process is done asynchronously, you can check from the `status` field of the resource response.
arguments:
'body':
type: 'NosqlresourceNoSQLResourceConfiguration'
required: true
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[Union[None, ApimodelNoSQLResourceResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/create_no_sql_cluster_v2.py'
example: |-
result, error = csm.create_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'create'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'create_no_sql_database_credential_v2@py.csm.fun':
id: 'create_no_sql_database_credential_v2@py.csm.fun'
name: 'create_no_sql_database_credential_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:DATABASECREDENTIALS [CREATE]`
Creates a new database credential for the customer. This will soft-delete the old credential and create a new one.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelCreateNoSQLDatabaseCredentialRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelNoSQLDatabaseCredentialResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/create_no_sql_database__189b02.py'
example: |-
result, error = csm.create_no_sql_database_credential_v2(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'credential'
- 'database'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'create_no_sql_database_v2@py.csm.fun':
id: 'create_no_sql_database_v2@py.csm.fun'
name: 'create_no_sql_database_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:DATABASES [CREATE]`
Creates a NoSQL database along with its credentials associated with given extend app. The database will be created in the provisioned NoSQL cluster.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelCreateNoSQLAppDatabaseRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelNoSQLDatabaseResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/create_no_sql_database_v2.py'
example: |-
result, error = csm.create_no_sql_database_v2(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'database'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'create_subscription_handler@py.csm.fun':
id: 'create_subscription_handler@py.csm.fun'
name: 'create_subscription_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:ASYNCMESSAGING:SUBSCRIPTIONS [CREATE]`
Subscribe App queue to given Topic name list inside a game namespace.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelCreateSubscriptionRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelCreateSubscriptionResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/async_messaging/create_subscription_handler.py'
example: |-
result, error = csm.create_subscription_handler(...)
if error:
# handle_error(error)
tags:
- 'async'
- 'create'
- 'handler'
- 'messaging'
- 'subscription'
'create_topic_handler@py.csm.fun':
id: 'create_topic_handler@py.csm.fun'
name: 'create_topic_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:ASYNCMESSAGING:TOPICS [CREATE]`
Create New Async Messaging Topic, the topic name is unique inside a game namespace.
arguments:
'body':
type: 'ApimodelCreateTopicRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelTopicResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/async_messaging/create_topic_handler.py'
example: |-
result, error = csm.create_topic_handler(...)
if error:
# handle_error(error)
tags:
- 'async'
- 'create'
- 'handler'
- 'messaging'
- 'topic'
'delete_app_images_v1@py.csm.fun':
id: 'delete_app_images_v1@py.csm.fun'
name: 'delete_app_images_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:IMAGE [DELETE]`
Deletes the images uploaded to the repository
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedDeleteAppImagesV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/image/delete_app_images_v1.py'
example: |-
result, error = csm.delete_app_images_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'image'
- 'images'
- 'v1'
'delete_app_images_v2@py.csm.fun':
id: 'delete_app_images_v2@py.csm.fun'
name: 'delete_app_images_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:IMAGE [DELETE]`
Deletes list of provided image tags from the app image repository
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedDeleteAppImagesV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/image_v2/delete_app_images_v2.py'
example: |-
result, error = csm.delete_app_images_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'image'
- 'images'
- 'v2'
'delete_app_v1@py.csm.fun':
id: 'delete_app_v1@py.csm.fun'
name: 'delete_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [DELETE]`
Delete App by given DeploymentID
This endpoint intended to delete ECR repo, ECR manifests, service images, uninstall helm-release,
and update the deleted_at in DB by given App Name.
Required: Valid Access Token
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'forced':
type: 'Optional[str]'
required: false
description: |-
Force App Deletion
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/delete_app_v1.py'
example: |-
result, error = csm.delete_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'v1'
'delete_app_v2@py.csm.fun':
id: 'delete_app_v2@py.csm.fun'
name: 'delete_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [DELETE]`
Delete extend app by given {app} name
This endpoint will delete app information, configuration, deployments and all related manifest from
db, storage and cluster
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'forced':
type: 'Optional[str]'
required: false
description: |-
Force app deletion, if 'true' will proceed delete regardless of current app status (default: false)
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/delete_app_v2.py'
example: |-
result, error = csm.delete_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'v2'
'delete_deployment_v1@py.csm.fun':
id: 'delete_deployment_v1@py.csm.fun'
name: 'delete_deployment_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [DELETE]`
Delete Deployment information by given DeploymentID
This endpoint intended to delete helm release object and update the deleted_at in DB by given Deployment ID.
Required: Valid Access Token
arguments:
'deployment_id':
type: 'str'
required: true
description: |-
Deployment ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment/delete_deployment_v1.py'
example: |-
result, error = csm.delete_deployment_v1(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'deployment'
- 'v1'
'delete_deployment_v2@py.csm.fun':
id: 'delete_deployment_v2@py.csm.fun'
name: 'delete_deployment_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [DELETE]`
Delete Deployment information by given DeploymentID
This endpoint will delete release object for the service deployment in the cluster
Required: Valid Access Token
arguments:
'deployment_id':
type: 'str'
required: true
description: |-
Deployment ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment_v2/delete_deployment_v2.py'
example: |-
result, error = csm.delete_deployment_v2(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'deployment'
- 'v2'
'delete_no_sql_cluster_v2@py.csm.fun':
id: 'delete_no_sql_cluster_v2@py.csm.fun'
name: 'delete_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [DELETE]`
You can only delete the cluster when its status is "available".
Deleting the cluster will:
- Remove NoSQL integration.
- Remove all the data from the NoSQL
- Remove all the credentials, including the Extend Appâs credentials.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[Union[None, ApimodelDeleteNoSQLResourceResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/delete_no_sql_cluster_v2.py'
example: |-
result, error = csm.delete_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'delete'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'delete_no_sql_database_v2@py.csm.fun':
id: 'delete_no_sql_database_v2@py.csm.fun'
name: 'delete_no_sql_database_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:DATABASES [DELETE]`
Deletes a NoSQL database and its credentials associated with given extend app and game namespace. The database will be removed from the provisioned NoSQL cluster.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelNoSQLDatabaseDeleteResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/delete_no_sql_database_v2.py'
example: |-
result, error = csm.delete_no_sql_database_v2(...)
if error:
# handle_error(error)
tags:
- 'database'
- 'delete'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'delete_secret_v1@py.csm.fun':
id: 'delete_secret_v1@py.csm.fun'
name: 'delete_secret_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [DELETE]`
Delete an environment secret.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/delete_secret_v1.py'
example: |-
result, error = csm.delete_secret_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'delete'
- 'secret'
- 'v1'
'delete_secret_v2@py.csm.fun':
id: 'delete_secret_v2@py.csm.fun'
name: 'delete_secret_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [DELETE]`
Delete an environment secret by its config id
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/delete_secret_v2.py'
example: |-
result, error = csm.delete_secret_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'delete'
- 'secret'
- 'v2'
'delete_subscription_app_notification_by_user_idv2@py.csm.fun':
id: 'delete_subscription_app_notification_by_user_idv2@py.csm.fun'
name: 'delete_subscription_app_notification_by_user_idv2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [DELETE]`
Remove a user from the notification subscription by user ID.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/delete_subscription_app_0003d9.py'
example: |-
result, error = csm.delete_subscription_app_notification_by_user_idv2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'by'
- 'delete'
- 'idv2'
- 'notification'
- 'subscription'
- 'user'
'delete_subscription_app_notification_v2@py.csm.fun':
id: 'delete_subscription_app_notification_v2@py.csm.fun'
name: 'delete_subscription_app_notification_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [DELETE]`
Remove a user from the notification subscription.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'subscription_id':
type: 'str'
required: true
description: |-
Subscription ID
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/delete_subscription_app_84e329.py'
example: |-
result, error = csm.delete_subscription_app_notification_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'notification'
- 'subscription'
- 'v2'
'delete_subscription_app_notification_v3@py.csm.fun':
id: 'delete_subscription_app_notification_v3@py.csm.fun'
name: 'delete_subscription_app_notification_v3'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [DELETE]`
Remove a user from the notification subscription using either user ID or email address.
Only one of them should be provided.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'email_address':
type: 'Optional[str]'
required: false
description: |-
emailAddress
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'user_id':
type: 'Optional[str]'
required: false
description: |-
userID
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription_v3/delete_subscription_app_2aa6c7.py'
example: |-
result, error = csm.delete_subscription_app_notification_v3(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'delete'
- 'notification'
- 'subscription'
- 'v3'
'delete_topic_handler@py.csm.fun':
id: 'delete_topic_handler@py.csm.fun'
name: 'delete_topic_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:ASYNCMESSAGING:TOPICS [DELETE]`
Delete Async Messaging Topic inside a game namespace given its topic name.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Game Name
'topic_name':
type: 'str'
required: true
description: |-
Topic Name
return_type: 'Tuple[Union[None, ApimodelTopicResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/async_messaging/delete_topic_handler.py'
example: |-
result, error = csm.delete_topic_handler(...)
if error:
# handle_error(error)
tags:
- 'async'
- 'delete'
- 'handler'
- 'messaging'
- 'topic'
'delete_variable_v1@py.csm.fun':
id: 'delete_variable_v1@py.csm.fun'
name: 'delete_variable_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [DELETE]`
Delete an environment variable.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/delete_variable_v1.py'
example: |-
result, error = csm.delete_variable_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'delete'
- 'v1'
- 'variable'
'delete_variable_v2@py.csm.fun':
id: 'delete_variable_v2@py.csm.fun'
name: 'delete_variable_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [DELETE]`
Delete an environment variable by its config id
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/delete_variable_v2.py'
example: |-
result, error = csm.delete_variable_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'delete'
- 'v2'
- 'variable'
'get_app_image_list_v1@py.csm.fun':
id: 'get_app_image_list_v1@py.csm.fun'
name: 'get_app_image_list_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:IMAGE [READ]`
Get a list of container images
Default 'cached' parameter is 'true'
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'cached':
type: 'Optional[str]'
required: false
description: |-
Get Cached Images
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, GeneratedGetAppImageListV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/image/get_app_image_list_v1.py'
example: |-
result, error = csm.get_app_image_list_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'image'
- 'list'
- 'v1'
'get_app_image_list_v2@py.csm.fun':
id: 'get_app_image_list_v2@py.csm.fun'
name: 'get_app_image_list_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:IMAGE [READ]`
Get a list of container images
Default 'cached' parameter is 'true'
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'cached':
type: 'Optional[str]'
required: false
description: |-
Get Cached Images
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelGetAppImageListV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/image_v2/get_app_image_list_v2.py'
example: |-
result, error = csm.get_app_image_list_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'image'
- 'list'
- 'v2'
'get_app_list_v1@py.csm.fun':
id: 'get_app_list_v1@py.csm.fun'
name: 'get_app_list_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]`
Gets the List of Apps for AB-Extend Customer
Available scenario:
- scenario 3: `event-handler`
- scenario 1: `function-override`
- scenario 2: `service-extension`
arguments:
'body':
type: 'GeneratedGetAppListV1Request'
required: true
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, GeneratedGetAppListV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/get_app_list_v1.py'
example: |-
result, error = csm.get_app_list_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'list'
- 'v1'
'get_app_list_v2@py.csm.fun':
id: 'get_app_list_v2@py.csm.fun'
name: 'get_app_list_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]`
Get list of extend apps on a given game namespace
arguments:
'body':
type: 'ApimodelGetAppListV2Request'
required: true
'limit':
type: 'Optional[int]'
required: false
description: |-
Maximum number of apps items returned
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
Starting point offset items
return_type: 'Tuple[Union[None, ApimodelGetAppListV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/get_app_list_v2.py'
example: |-
result, error = csm.get_app_list_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'list'
- 'v2'
'get_app_release_v1@py.csm.fun':
id: 'get_app_release_v1@py.csm.fun'
name: 'get_app_release_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]`
Gets the Latest Release Version info of this App
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedGetAppReleaseV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/get_app_release_v1.py'
example: |-
result, error = csm.get_app_release_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'release'
- 'v1'
'get_app_v1@py.csm.fun':
id: 'get_app_v1@py.csm.fun'
name: 'get_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]`
Gets the App By Name
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedGetAppV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/get_app_v1.py'
example: |-
result, error = csm.get_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'v1'
'get_app_v2@py.csm.fun':
id: 'get_app_v2@py.csm.fun'
name: 'get_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]`
Get extend app by name
Available scenario:
- scenario 1: `function-override`
- scenario 2: `service-extension`
- scenario 3: `event-handler`
Available app status:
- `app-creating`
- `app-creation-failed`
- `app-creation-timeout`
- `app-undeployed`
- `deployment-in-progress`
- `deployment-failed`
- `deployment-timeout`
- `deployment-running`
- `deployment-down`
- `app-stopping`
- `app-stop-failed`
- `app-stop-timeout`
- `app-stopped`
- `app-removing`
- `app-removed`
- `app-remove-timeout`
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelAppItem], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/get_app_v2.py'
example: |-
result, error = csm.get_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'get'
- 'v2'
'get_deployment_v1@py.csm.fun':
id: 'get_deployment_v1@py.csm.fun'
name: 'get_deployment_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [READ]`
Get Deployment information by given DeploymentID
This endpoint intended to get Deployment information by given Deployment ID from Deployment Table.
Required: Valid Access Token
arguments:
'deployment_id':
type: 'str'
required: true
description: |-
Deployment ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedGetDeploymentV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment/get_deployment_v1.py'
example: |-
result, error = csm.get_deployment_v1(...)
if error:
# handle_error(error)
tags:
- 'deployment'
- 'get'
- 'v1'
'get_deployment_v2@py.csm.fun':
id: 'get_deployment_v2@py.csm.fun'
name: 'get_deployment_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [READ]`
Get Deployment information by given DeploymentID
This endpoint intended to get Deployment information.
Required: Valid Access Token
arguments:
'deployment_id':
type: 'str'
required: true
description: |-
Deployment ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelGetDeploymentListV2DataItem], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment_v2/get_deployment_v2.py'
example: |-
result, error = csm.get_deployment_v2(...)
if error:
# handle_error(error)
tags:
- 'deployment'
- 'get'
- 'v2'
'get_list_of_deployment_v1@py.csm.fun':
id: 'get_list_of_deployment_v1@py.csm.fun'
name: 'get_list_of_deployment_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [READ]`
Filters the List of Deployments
This endpoint intended to get list of Deployment done for the given publisher and game.
Required: Valid Access Token
arguments:
'body':
type: 'GeneratedGetDeploymentListV1Request'
required: true
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, GeneratedGetDeploymentListV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment/get_list_of_deployment_v1.py'
example: |-
result, error = csm.get_list_of_deployment_v1(...)
if error:
# handle_error(error)
tags:
- 'deployment'
- 'get'
- 'list'
- 'of'
- 'v1'
'get_list_of_deployment_v2@py.csm.fun':
id: 'get_list_of_deployment_v2@py.csm.fun'
name: 'get_list_of_deployment_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:DEPLOYMENT [READ]`
Filters the List of Deployments
This endpoint intended to get list of Deployment done for the given publisher and game.
Request :
- appIds : list of app ids
- deploymentIds: list of deployment ids
- statuses:
deployment-in-progress
deployment-failed
deployment-timeout
deployment-running
deployment-down
Required: Valid Access Token
arguments:
'body':
type: 'ApimodelGetDeploymentListV2Request'
required: true
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, ApimodelGetDeploymentListV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/deployment_v2/get_list_of_deployment_v2.py'
example: |-
result, error = csm.get_list_of_deployment_v2(...)
if error:
# handle_error(error)
tags:
- 'deployment'
- 'get'
- 'list'
- 'of'
- 'v2'
'get_list_of_secrets_v1@py.csm.fun':
id: 'get_list_of_secrets_v1@py.csm.fun'
name: 'get_list_of_secrets_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [READ]`
Get list of environment secrets per app
Available Deployment Status:
`deployed` = app config is already deployed
`undeployed` = app config is not deployed yet and need restart and deploy of the app to be deployed
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, GeneratedGetListOfConfigurationsV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/get_list_of_secrets_v1.py'
example: |-
result, error = csm.get_list_of_secrets_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'get'
- 'list'
- 'of'
- 'secrets'
- 'v1'
'get_list_of_secrets_v2@py.csm.fun':
id: 'get_list_of_secrets_v2@py.csm.fun'
name: 'get_list_of_secrets_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [READ]`
Get list of environment secrets per app
Available Deployment Status:
`deployed` = app config is already deployed
`undeployed` = app config is not deployed yet and need restart and deploy of the app to be deployed
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, ApimodelGetListOfConfigurationsV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/get_list_of_secrets_v2.py'
example: |-
result, error = csm.get_list_of_secrets_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'get'
- 'list'
- 'of'
- 'secrets'
- 'v2'
'get_list_of_variables_v1@py.csm.fun':
id: 'get_list_of_variables_v1@py.csm.fun'
name: 'get_list_of_variables_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [READ]`
Get list of environment variables per app
Available Deployment Status:
`deployed` = app config is already deployed
`undeployed` = app config is not deployed yet and need restart and deploy of the app to be deployed
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, GeneratedGetListOfConfigurationsV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/get_list_of_variables_v1.py'
example: |-
result, error = csm.get_list_of_variables_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'get'
- 'list'
- 'of'
- 'v1'
- 'variables'
'get_list_of_variables_v2@py.csm.fun':
id: 'get_list_of_variables_v2@py.csm.fun'
name: 'get_list_of_variables_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [READ]`
Get list of environment variables per app
Available Deployment Status:
`deployed` = app config is already deployed
`undeployed` = app config is not deployed yet and need restart and deploy of the app to be deployed
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset
return_type: 'Tuple[Union[None, ApimodelGetListOfConfigurationsV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/get_list_of_variables_v2.py'
example: |-
result, error = csm.get_list_of_variables_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'get'
- 'list'
- 'of'
- 'v2'
- 'variables'
'get_no_sql_access_tunnel_v2@py.csm.fun':
id: 'get_no_sql_access_tunnel_v2@py.csm.fun'
name: 'get_no_sql_access_tunnel_v2'
type: 'function'
description: |-
Returns the NoSQL access tunnel information for a specified game namespace
arguments:
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelTunnelInfoResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/get_no_sql_access_tunnel_v2.py'
example: |-
result, error = csm.get_no_sql_access_tunnel_v2(...)
if error:
# handle_error(error)
tags:
- 'access'
- 'get'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'tunnel'
- 'v2'
'get_no_sql_cluster_v2@py.csm.fun':
id: 'get_no_sql_cluster_v2@py.csm.fun'
name: 'get_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [READ]`
Get NoSQL cluster information returns the NoSQL cluster related information by given studio/publisher namespace.
`status` field - indicates the NoSQL cluster status:
- `updating` : The cluster is being modified and is not yet accessible (e.g., updating min/max DCU).
- `creating` : The cluster or instance is being created and is not yet accessible.
- `deleting` : The cluster is in the process of being deleted and is not accessible.
- `stopping` : The cluster is in the process of stopping and will soon become inaccessible.
- `stopped` : The cluster is stopped and not accessible.
- `available` : The cluster is accessible.
- `failed` : The cluster failed to provision or is in an error state and not accessible.
- `starting` : The cluster is transitioning from stopped to running, or is rebooting.
- `maintenance` : The cluster is undergoing maintenance operations and is not accessible.
- `unknown` : The cluster status is not recognized
arguments:
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[Union[None, ApimodelNoSQLResourceResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/get_no_sql_cluster_v2.py'
example: |-
result, error = csm.get_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'get'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'get_no_sql_database_v2@py.csm.fun':
id: 'get_no_sql_database_v2@py.csm.fun'
name: 'get_no_sql_database_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:DATABASES [READ]`
Get a NoSQL database information returns the NoSQL database related information by given game namespace
and app name.
`resourceStatus` field - indicates the NoSQL cluster status:
- `stopping` : The cluster is in the process of stopping and will soon become inaccessible.
- `stopped` : The cluster is stopped and not accessible.
- `available` : The cluster is accessible.
- `failed` : The cluster failed to provision or is in an error state and not accessible.
- `starting` : The cluster is transitioning from stopped to running, or is rebooting.
- `maintenance` : The cluster is undergoing maintenance operations and is not accessible.
- `unknown` : The cluster status is not recognized
- `updating` : The cluster is being modified and is not yet accessible (e.g., updating min/max DCU).
- `creating` : The cluster or instance is being created and is not yet accessible.
- `deleting` : The cluster is in the process of being deleted and is not accessible.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, ApimodelNoSQLDatabaseResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/get_no_sql_database_v2.py'
example: |-
result, error = csm.get_no_sql_database_v2(...)
if error:
# handle_error(error)
tags:
- 'database'
- 'get'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'v2'
'get_notification_subscriber_list_v2@py.csm.fun':
id: 'get_notification_subscriber_list_v2@py.csm.fun'
name: 'get_notification_subscriber_list_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [READ]`
Request param:
- notificationType : type of the subscribed app notification
- values:
- all
- app-down
- critical-vulnerability
Get a list of the app notification subscriber
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'notification_type':
type: 'str'
required: true
description: |-
Notification Type
return_type: 'Tuple[Union[None, ApimodelGetNotificationSubscriberListResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/get_notification_subscr_4bced3.py'
example: |-
result, error = csm.get_notification_subscriber_list_v2(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'list'
- 'notification'
- 'subscriber'
- 'subscription'
- 'v2'
'get_notification_subscriber_list_v3@py.csm.fun':
id: 'get_notification_subscriber_list_v3@py.csm.fun'
name: 'get_notification_subscriber_list_v3'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [READ]`
Request param:
- notificationType : type of the subscribed app notification
- values:
- all
- app-down
- critical-vulnerability
Get a list of the app notification subscriber
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
'notification_type':
type: 'str'
required: true
description: |-
Notification Type
return_type: 'Tuple[Union[None, ApimodelGetNotificationSubscriberListResponseV2], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription_v3/get_notification_subscr_6c8308.py'
example: |-
result, error = csm.get_notification_subscriber_list_v3(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'list'
- 'notification'
- 'subscriber'
- 'subscription'
- 'v3'
'get_resources_limits@py.csm.fun':
id: 'get_resources_limits@py.csm.fun'
name: 'get_resources_limits'
type: 'function'
description: |-
This endpoint return the Extend Apps Configurable Limits for front end to use for initial validation before app creation
e.g.
Replica Limit will be used to check max replica that can be created for the said environment by default
CPU Limit will be used to validate max allowed CPU for the extend app that hasn't been created
Memory Limit will be used to validate max allowed Memory for the extend app that hasn't been created
MaxAppNotificationSubscription will be used to validate the maximum number of subscriber for an app status notification
arguments:
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelCSMAppLimitsResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/resources_limits/get_resources_limits.py'
example: |-
result, error = csm.get_resources_limits(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'limits'
- 'resources'
'get_subscription_v2_handler@py.csm.fun':
id: 'get_subscription_v2_handler@py.csm.fun'
name: 'get_subscription_v2_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SELF:SUBSCRIPTION [READ]`
Get Subscription status of a user
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelGetNotificationSubscriberStatusResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/get_subscription_v2_handler.py'
example: |-
result, error = csm.get_subscription_v2_handler(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'handler'
- 'notification'
- 'subscription'
- 'v2'
'list_topics_handler@py.csm.fun':
id: 'list_topics_handler@py.csm.fun'
name: 'list_topics_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:ASYNCMESSAGING:TOPICS [READ]`
List all Async Messaging Topics inside a game namespace.
arguments:
'fuzzy_topic_name':
type: 'Optional[str]'
required: false
description: |-
Fuzzy search for topic name
'is_subscribed_by_app_name':
type: 'Optional[str]'
required: false
description: |-
Filter to get only topics subscribed by given app name
'is_unsubscribed_by_app_name':
type: 'Optional[str]'
required: false
description: |-
Filter to get only topics unsubscribed by given app name
'limit':
type: 'Optional[int]'
required: false
description: |-
Limit for pagination
'namespace':
type: 'str'
required: true
description: |-
Game Name
'offset':
type: 'Optional[int]'
required: false
description: |-
Offset for pagination
return_type: 'Tuple[Union[None, ApimodelListTopicsResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/async_messaging/list_topics_handler.py'
example: |-
result, error = csm.list_topics_handler(...)
if error:
# handle_error(error)
tags:
- 'async'
- 'handler'
- 'list'
- 'messaging'
- 'topics'
'public_get_messages@py.csm.fun':
id: 'public_get_messages@py.csm.fun'
name: 'public_get_messages'
type: 'function'
description: |-
get the list of messages.
return_type: 'Tuple[Union[None, List[LogAppMessageDeclaration]], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/messages/public_get_messages.py'
example: |-
result, error = csm.public_get_messages(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'messages'
- 'public'
'save_secret_v1@py.csm.fun':
id: 'save_secret_v1@py.csm.fun'
name: 'save_secret_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [CREATE]`
Save an environment secret.
Request body:
- configName : environment secret name - Required.
- source : source of the configuration value (plaintext or ssm) - Required.
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedSaveConfigurationV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedSaveConfigurationV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/save_secret_v1.py'
example: |-
result, error = csm.save_secret_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'save'
- 'secret'
- 'v1'
'save_secret_v2@py.csm.fun':
id: 'save_secret_v2@py.csm.fun'
name: 'save_secret_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [CREATE]`
Save an environment secret.
Secret will always be masked.
Request body:
- configName : environment secret name - Required.
- source : source of the configuration value (plaintext or ssm) - Required.
- value : configuration value - Required.
- description : description of the configuration - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelSaveSecretConfigurationV2Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelSaveConfigurationV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/save_secret_v2.py'
example: |-
result, error = csm.save_secret_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'save'
- 'secret'
- 'v2'
'save_variable_v1@py.csm.fun':
id: 'save_variable_v1@py.csm.fun'
name: 'save_variable_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [CREATE]`
Save an environment variable.
Request body:
- configName : environment variable name - Required.
- source : source of the configuration value (plaintext or ssm) - Required.
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedSaveConfigurationV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedSaveConfigurationV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/save_variable_v1.py'
example: |-
result, error = csm.save_variable_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'save'
- 'v1'
- 'variable'
'save_variable_v2@py.csm.fun':
id: 'save_variable_v2@py.csm.fun'
name: 'save_variable_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [CREATE]`
Save an environment variable.
Request body:
- configName : environment variable name - Required.
- source : source of the configuration value (plaintext or ssm) - Required.
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelSaveConfigurationV2Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelSaveConfigurationV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/save_variable_v2.py'
example: |-
result, error = csm.save_variable_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'save'
- 'v2'
- 'variable'
'start_app_v1@py.csm.fun':
id: 'start_app_v1@py.csm.fun'
name: 'start_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Starts the Application
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'GeneratedStartAppV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedStartAppV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/start_app_v1.py'
example: |-
result, error = csm.start_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'start'
- 'v1'
'start_app_v2@py.csm.fun':
id: 'start_app_v2@py.csm.fun'
name: 'start_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Starts the Application
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/start_app_v2.py'
example: |-
result, error = csm.start_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'start'
- 'v2'
'start_no_sql_cluster_v2@py.csm.fun':
id: 'start_no_sql_cluster_v2@py.csm.fun'
name: 'start_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [UPDATE]`
Start NoSQL cluster.
You can only start the cluster when its status is "stopped".
Cluster starting process may take some time to complete.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/start_no_sql_cluster_v2.py'
example: |-
result, error = csm.start_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'start'
- 'v2'
'stop_app_v1@py.csm.fun':
id: 'stop_app_v1@py.csm.fun'
name: 'stop_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Stops the Application
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'GeneratedStopAppV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedStopAppV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/stop_app_v1.py'
example: |-
result, error = csm.stop_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'stop'
- 'v1'
'stop_app_v2@py.csm.fun':
id: 'stop_app_v2@py.csm.fun'
name: 'stop_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Stops the Application
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/stop_app_v2.py'
example: |-
result, error = csm.stop_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'stop'
- 'v2'
'stop_no_sql_cluster_v2@py.csm.fun':
id: 'stop_no_sql_cluster_v2@py.csm.fun'
name: 'stop_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [UPDATE]`
Stop NoSQL cluster.
You can only start the cluster when its status is "available".
Cluster stopping process may take some time to complete.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/stop_no_sql_cluster_v2.py'
example: |-
result, error = csm.stop_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'stop'
- 'v2'
'subscribe_app_notification_v2@py.csm.fun':
id: 'subscribe_app_notification_v2@py.csm.fun'
name: 'subscribe_app_notification_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SUBSCRIPTION [CREATE]`
Subscribe the user(s) an app notification.
Request body:
- notificationType : type of the app notification to be subscribed - Required.
- values:
- "all"
- "app-down"
- "critical-vulnerability"
- subscribers : user(s) to subscribe the app notification - Required.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelSubscribeNotificationRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelSubscribeNotificationResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/subscribe_app_notification_v2.py'
example: |-
result, error = csm.subscribe_app_notification_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'notification'
- 'subscribe'
- 'subscription'
- 'v2'
'subscribe_v2_handler@py.csm.fun':
id: 'subscribe_v2_handler@py.csm.fun'
name: 'subscribe_v2_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SELF:SUBSCRIPTION [CREATE]`
Subscribe to app notification
Request body:
- notificationType : type of the app notification to be subscribed - Required.
- values:
- "all"
- "app-down"
- "critical-vulnerability"
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelSelfSubscribeNotificationRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/subscribe_v2_handler.py'
example: |-
result, error = csm.subscribe_v2_handler(...)
if error:
# handle_error(error)
tags:
- 'handler'
- 'notification'
- 'subscribe'
- 'subscription'
- 'v2'
'unsubscribe_topic_handler@py.csm.fun':
id: 'unsubscribe_topic_handler@py.csm.fun'
name: 'unsubscribe_topic_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:ASYNCMESSAGING:SUBSCRIPTIONS [DELETE]`
Unsubscribe App queue from a topic by Topic Name.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Name
'topic_name':
type: 'str'
required: true
description: |-
Topic Name
return_type: 'Tuple[Union[None, ApimodelTopicSubscription], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/async_messaging/unsubscribe_topic_handler.py'
example: |-
result, error = csm.unsubscribe_topic_handler(...)
if error:
# handle_error(error)
tags:
- 'async'
- 'handler'
- 'messaging'
- 'topic'
- 'unsubscribe'
'unsubscribe_v2_handler@py.csm.fun':
id: 'unsubscribe_v2_handler@py.csm.fun'
name: 'unsubscribe_v2_handler'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP:ALERT:SELF:SUBSCRIPTION [DELETE]`
Unsubscribe to app notification
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/notification_subscription/unsubscribe_v2_handler.py'
example: |-
result, error = csm.unsubscribe_v2_handler(...)
if error:
# handle_error(error)
tags:
- 'handler'
- 'notification'
- 'subscription'
- 'unsubscribe'
- 'v2'
'update_app_resources_resource_limit_form_v2@py.csm.fun':
id: 'update_app_resources_resource_limit_form_v2@py.csm.fun'
name: 'update_app_resources_resource_limit_form_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Update app resources provided on request body
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'ApimodelIncreaseLimitFormRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/update_app_resources_re_e22dc4.py'
example: |-
result, error = csm.update_app_resources_resource_limit_form_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'form'
- 'limit'
- 'resource'
- 'resources'
- 'update'
- 'v2'
'update_app_resources_v2@py.csm.fun':
id: 'update_app_resources_v2@py.csm.fun'
name: 'update_app_resources_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Update app resources provided on request body
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'ApimodelUpdateAppResourceRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelAppItem], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/update_app_resources_v2.py'
example: |-
result, error = csm.update_app_resources_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'resources'
- 'update'
- 'v2'
'update_app_v1@py.csm.fun':
id: 'update_app_v1@py.csm.fun'
name: 'update_app_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Update App Partially
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'GeneratedUpdateAppV1Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedUpdateAppV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app/update_app_v1.py'
example: |-
result, error = csm.update_app_v1(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'update'
- 'v1'
'update_app_v2@py.csm.fun':
id: 'update_app_v2@py.csm.fun'
name: 'update_app_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:APP [UPDATE]`
Update app info provided on request body
arguments:
'app':
type: 'str'
required: true
description: |-
App Name. Expected format: (^[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?$)
'body':
type: 'ApimodelUpdateAppV2Request'
required: true
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelAppItem], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/app_v2/update_app_v2.py'
example: |-
result, error = csm.update_app_v2(...)
if error:
# handle_error(error)
tags:
- 'app'
- 'update'
- 'v2'
'update_no_sql_cluster_v2@py.csm.fun':
id: 'update_no_sql_cluster_v2@py.csm.fun'
name: 'update_no_sql_cluster_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:NOSQL:CLUSTERS [UPDATE]`
Update NoSQL cluster configurations such as min/max DCU (Database Capacity Units) for the NoSQL cluster in the given studio/publisher namespace.
The cluster must be in an available state to allow configuration updates.
Configuration update process may take some time to complete, you can check the updated status from the `status` field of the resource response.
arguments:
'body':
type: 'NosqlresourceNoSQLResourceConfiguration'
required: true
'namespace':
type: 'str'
required: true
description: |-
Studio Name
return_type: 'Tuple[Union[None, ApimodelNoSQLResourceResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/managed_resources/update_no_sql_cluster_v2.py'
example: |-
result, error = csm.update_no_sql_cluster_v2(...)
if error:
# handle_error(error)
tags:
- 'cluster'
- 'managed'
- 'no'
- 'resources'
- 'sql'
- 'update'
- 'v2'
'update_secret_v1@py.csm.fun':
id: 'update_secret_v1@py.csm.fun'
name: 'update_secret_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [UPDATE]`
Update an environment secret.
Request body:
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedUpdateConfigurationV1Request'
required: true
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedUpdateConfigurationV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/update_secret_v1.py'
example: |-
result, error = csm.update_secret_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'secret'
- 'update'
- 'v1'
'update_secret_v2@py.csm.fun':
id: 'update_secret_v2@py.csm.fun'
name: 'update_secret_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:SECRET [UPDATE]`
Update an environment secret.
Secret will always be masked.
Request body:
- value : configuration value - Required.
- description : description of the configuration - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelUpdateSecretConfigurationV2Request'
required: true
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelUpdateConfigurationV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/update_secret_v2.py'
example: |-
result, error = csm.update_secret_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'secret'
- 'update'
- 'v2'
'update_variable_v1@py.csm.fun':
id: 'update_variable_v1@py.csm.fun'
name: 'update_variable_v1'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [UPDATE]`
Update an environment variable.
Request body:
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'GeneratedUpdateConfigurationV1Request'
required: true
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Name
return_type: 'Tuple[Union[None, GeneratedUpdateConfigurationV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration/update_variable_v1.py'
example: |-
result, error = csm.update_variable_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'update'
- 'v1'
- 'variable'
'update_variable_v2@py.csm.fun':
id: 'update_variable_v2@py.csm.fun'
name: 'update_variable_v2'
type: 'function'
description: |-
Required permission : `ADMIN:NAMESPACE:{namespace}:EXTEND:VARIABLE [UPDATE]`
Update an environment variable.
Request body:
- value : configuration value - Required.
- description : description of the configuration - Optional.
- applyMask : mask the value in the Helm manifest for sensitive information (true or false) - Optional.
arguments:
'app':
type: 'str'
required: true
description: |-
App Name
'body':
type: 'ApimodelUpdateConfigurationV2Request'
required: true
'config_id':
type: 'str'
required: true
description: |-
Config ID
'namespace':
type: 'str'
required: true
description: |-
Game Namespace
return_type: 'Tuple[Union[None, ApimodelUpdateConfigurationV2Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.csm as csm'
- 'import accelbyte_py_sdk.api.csm.models as csm_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/csm/operations/configuration_v2/update_variable_v2.py'
example: |-
result, error = csm.update_variable_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'update'
- 'v2'
- 'variable'
# endregion functions