symbols:
# region models
'ApiAccountCreateRequest@py.ams.mod':
id: 'ApiAccountCreateRequest@py.ams.mod'
name: 'ApiAccountCreateRequest'
type: 'model'
fields:
'name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_create_request.py'
example: |-
api_account_create_request = ams_models.ApiAccountCreateRequest.create(...)
'ApiAccountCreateResponse@py.ams.mod':
id: 'ApiAccountCreateResponse@py.ams.mod'
name: 'ApiAccountCreateResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'limits':
type: 'ApiAccountLimits'
required: true
'name':
type: 'str'
required: true
'namespaces':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_create_response.py'
example: |-
api_account_create_response = ams_models.ApiAccountCreateResponse.create(...)
'ApiAccountLimits@py.ams.mod':
id: 'ApiAccountLimits@py.ams.mod'
name: 'ApiAccountLimits'
type: 'model'
fields:
'allowed_node_classes':
type: 'List[str]'
required: false
'allowed_regions':
type: 'List[str]'
required: false
'fleet_count':
type: 'int'
required: false
'fleet_vm_count':
type: 'int'
required: false
'image_storage_quota_bytes':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_limits.py'
example: |-
api_account_limits = ams_models.ApiAccountLimits.create(...)
'ApiAccountLinkRequest@py.ams.mod':
id: 'ApiAccountLinkRequest@py.ams.mod'
name: 'ApiAccountLinkRequest'
type: 'model'
fields:
'token':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_link_request.py'
example: |-
api_account_link_request = ams_models.ApiAccountLinkRequest.create(...)
'ApiAccountLinkResponse@py.ams.mod':
id: 'ApiAccountLinkResponse@py.ams.mod'
name: 'ApiAccountLinkResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'limits':
type: 'ApiAccountLimits'
required: true
'name':
type: 'str'
required: true
'namespaces':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_link_response.py'
example: |-
api_account_link_response = ams_models.ApiAccountLinkResponse.create(...)
'ApiAccountLinkTokenResponse@py.ams.mod':
id: 'ApiAccountLinkTokenResponse@py.ams.mod'
name: 'ApiAccountLinkTokenResponse'
type: 'model'
fields:
'token':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_link_token_response.py'
example: |-
api_account_link_token_response = ams_models.ApiAccountLinkTokenResponse.create(...)
'ApiAccountResponse@py.ams.mod':
id: 'ApiAccountResponse@py.ams.mod'
name: 'ApiAccountResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'limits':
type: 'ApiAccountLimits'
required: true
'name':
type: 'str'
required: true
'namespaces':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_account_response.py'
example: |-
api_account_response = ams_models.ApiAccountResponse.create(...)
'ApiAMSRegionsResponse@py.ams.mod':
id: 'ApiAMSRegionsResponse@py.ams.mod'
name: 'ApiAMSRegionsResponse'
type: 'model'
fields:
'regions':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_ams_regions_response.py'
example: |-
api_ams_regions_response = ams_models.ApiAMSRegionsResponse.create(...)
'ApiArtifactListResponse@py.ams.mod':
id: 'ApiArtifactListResponse@py.ams.mod'
name: 'ApiArtifactListResponse'
type: 'model'
fields:
'data':
type: 'List[ApiArtifactResponse]'
required: true
'total_data':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_list_response.py'
example: |-
api_artifact_list_response = ams_models.ApiArtifactListResponse.create(...)
'ApiArtifactResponse@py.ams.mod':
id: 'ApiArtifactResponse@py.ams.mod'
name: 'ApiArtifactResponse'
type: 'model'
fields:
'artifact_type':
type: 'str'
required: true
'created_on':
type: 'str'
required: true
'ds_id':
type: 'str'
required: true
'expires_on':
type: 'str'
required: true
'filename':
type: 'str'
required: true
'fleet_id':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'image_id':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'region':
type: 'str'
required: true
'size_bytes':
type: 'int'
required: true
'status':
type: 'str'
required: true
'reason':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_response.py'
example: |-
api_artifact_response = ams_models.ApiArtifactResponse.create(...)
'ApiArtifactSamplingRule@py.ams.mod':
id: 'ApiArtifactSamplingRule@py.ams.mod'
name: 'ApiArtifactSamplingRule'
type: 'model'
fields:
'collect':
type: 'bool'
required: true
'percentage':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_sampling_rule.py'
example: |-
api_artifact_sampling_rule = ams_models.ApiArtifactSamplingRule.create(...)
'ApiArtifactTypeSamplingRules@py.ams.mod':
id: 'ApiArtifactTypeSamplingRules@py.ams.mod'
name: 'ApiArtifactTypeSamplingRules'
type: 'model'
fields:
'crashed':
type: 'ApiArtifactSamplingRule'
required: true
'success':
type: 'ApiArtifactSamplingRule'
required: true
'unclaimed':
type: 'ApiArtifactSamplingRule'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_type_sampling_rules.py'
example: |-
api_artifact_type_sampling_rules = ams_models.ApiArtifactTypeSamplingRules.create(...)
'ApiArtifactURLResponse@py.ams.mod':
id: 'ApiArtifactURLResponse@py.ams.mod'
name: 'ApiArtifactURLResponse'
type: 'model'
fields:
'url':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_url_response.py'
example: |-
api_artifact_url_response = ams_models.ApiArtifactURLResponse.create(...)
'ApiArtifactUsageResponse@py.ams.mod':
id: 'ApiArtifactUsageResponse@py.ams.mod'
name: 'ApiArtifactUsageResponse'
type: 'model'
fields:
'quota_bytes':
type: 'int'
required: true
'remaining_bytes':
type: 'int'
required: true
'used_bytes':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_artifact_usage_response.py'
example: |-
api_artifact_usage_response = ams_models.ApiArtifactUsageResponse.create(...)
'ApiCapacity@py.ams.mod':
id: 'ApiCapacity@py.ams.mod'
name: 'ApiCapacity'
type: 'model'
fields:
'region':
type: 'str'
required: true
'vm_count':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_capacity.py'
example: |-
api_capacity = ams_models.ApiCapacity.create(...)
'ApiCoredumpSamplingRules@py.ams.mod':
id: 'ApiCoredumpSamplingRules@py.ams.mod'
name: 'ApiCoredumpSamplingRules'
type: 'model'
fields:
'crashed':
type: 'ApiArtifactSamplingRule'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_coredump_sampling_rules.py'
example: |-
api_coredump_sampling_rules = ams_models.ApiCoredumpSamplingRules.create(...)
'ApiDevelopmentServerConfigurationCreateRequest@py.ams.mod':
id: 'ApiDevelopmentServerConfigurationCreateRequest@py.ams.mod'
name: 'ApiDevelopmentServerConfigurationCreateRequest'
type: 'model'
fields:
'command_line_arguments':
type: 'str'
required: true
'image_id':
type: 'str'
required: true
'name':
type: 'str'
required: true
'expires_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_development_server_configuration_create_request.py'
example: |-
api_development_server_configuration_create_request = ams_models.ApiDevelopmentServerConfigurationCreateRequest.create(...)
'ApiDevelopmentServerConfigurationCreateResponse@py.ams.mod':
id: 'ApiDevelopmentServerConfigurationCreateResponse@py.ams.mod'
name: 'ApiDevelopmentServerConfigurationCreateResponse'
type: 'model'
fields:
'name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_development_server_configuration_create_response.py'
example: |-
api_development_server_configuration_create_response = ams_models.ApiDevelopmentServerConfigurationCreateResponse.create(...)
'ApiDevelopmentServerConfigurationGetResponse@py.ams.mod':
id: 'ApiDevelopmentServerConfigurationGetResponse@py.ams.mod'
name: 'ApiDevelopmentServerConfigurationGetResponse'
type: 'model'
fields:
'command_line_arguments':
type: 'str'
required: true
'image_id':
type: 'str'
required: true
'name':
type: 'str'
required: true
'created_at':
type: 'str'
required: false
'expires_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_development_server_configuration_get_response.py'
example: |-
api_development_server_configuration_get_response = ams_models.ApiDevelopmentServerConfigurationGetResponse.create(...)
'ApiDevelopmentServerConfigurationListResponse@py.ams.mod':
id: 'ApiDevelopmentServerConfigurationListResponse@py.ams.mod'
name: 'ApiDevelopmentServerConfigurationListResponse'
type: 'model'
fields:
'data':
type: 'List[ApiDevelopmentServerConfigurationGetResponse]'
required: true
'paging':
type: 'PaginationPaginationInfo'
required: true
'total_data':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_development_server_configuration_list_response.py'
example: |-
api_development_server_configuration_list_response = ams_models.ApiDevelopmentServerConfigurationListResponse.create(...)
'ApiDevelopmentServerConfigurationUpdateRequest@py.ams.mod':
id: 'ApiDevelopmentServerConfigurationUpdateRequest@py.ams.mod'
name: 'ApiDevelopmentServerConfigurationUpdateRequest'
type: 'model'
fields:
'command_line_arguments':
type: 'str'
required: false
'expires_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_development_server_configuration_update_request.py'
example: |-
api_development_server_configuration_update_request = ams_models.ApiDevelopmentServerConfigurationUpdateRequest.create(...)
'ApiDSHistoryEvent@py.ams.mod':
id: 'ApiDSHistoryEvent@py.ams.mod'
name: 'ApiDSHistoryEvent'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'exit_code':
type: 'int'
required: true
'ip_address':
type: 'str'
required: true
'reason':
type: 'str'
required: true
'region':
type: 'str'
required: true
'server_id':
type: 'str'
required: true
'session_id':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_ds_history_event.py'
example: |-
api_ds_history_event = ams_models.ApiDSHistoryEvent.create(...)
'ApiDSHistoryList@py.ams.mod':
id: 'ApiDSHistoryList@py.ams.mod'
name: 'ApiDSHistoryList'
type: 'model'
fields:
'events':
type: 'List[ApiDSHistoryEvent]'
required: true
'paging':
type: 'ApiPagingInfo'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_ds_history_list.py'
example: |-
api_ds_history_list = ams_models.ApiDSHistoryList.create(...)
'ApiDSHostConfiguration@py.ams.mod':
id: 'ApiDSHostConfiguration@py.ams.mod'
name: 'ApiDSHostConfiguration'
type: 'model'
fields:
'instance_id':
type: 'str'
required: true
'instance_provider':
type: 'str'
required: true
'instance_type':
type: 'str'
required: true
'servers_per_vm':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_ds_host_configuration.py'
example: |-
api_ds_host_configuration = ams_models.ApiDSHostConfiguration.create(...)
'ApiDSHostConfigurationParameters@py.ams.mod':
id: 'ApiDSHostConfigurationParameters@py.ams.mod'
name: 'ApiDSHostConfigurationParameters'
type: 'model'
fields:
'instance_id':
type: 'str'
required: true
'servers_per_vm':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_ds_host_configuration_parameters.py'
example: |-
api_ds_host_configuration_parameters = ams_models.ApiDSHostConfigurationParameters.create(...)
'ApiFleetArtifactsSampleRules@py.ams.mod':
id: 'ApiFleetArtifactsSampleRules@py.ams.mod'
name: 'ApiFleetArtifactsSampleRules'
type: 'model'
fields:
'coredumps':
type: 'ApiCoredumpSamplingRules'
required: true
'logs':
type: 'ApiArtifactTypeSamplingRules'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_artifacts_sample_rules.py'
example: |-
api_fleet_artifacts_sample_rules = ams_models.ApiFleetArtifactsSampleRules.create(...)
'ApiFleetBulkActionErrorItemResponse@py.ams.mod':
id: 'ApiFleetBulkActionErrorItemResponse@py.ams.mod'
name: 'ApiFleetBulkActionErrorItemResponse'
type: 'model'
fields:
'fleet_id':
type: 'str'
required: true
'error_message':
type: 'str'
required: false
'error_type':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_bulk_action_error_item_response.py'
example: |-
api_fleet_bulk_action_error_item_response = ams_models.ApiFleetBulkActionErrorItemResponse.create(...)
'ApiFleetBulkDeleteRequest@py.ams.mod':
id: 'ApiFleetBulkDeleteRequest@py.ams.mod'
name: 'ApiFleetBulkDeleteRequest'
type: 'model'
fields:
'fleet_ids':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_bulk_delete_request.py'
example: |-
api_fleet_bulk_delete_request = ams_models.ApiFleetBulkDeleteRequest.create(...)
'ApiFleetBulkDeleteResponse@py.ams.mod':
id: 'ApiFleetBulkDeleteResponse@py.ams.mod'
name: 'ApiFleetBulkDeleteResponse'
type: 'model'
fields:
'errors':
type: 'List[ApiFleetBulkActionErrorItemResponse]'
required: true
'success_count':
type: 'int'
required: true
'total_count':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_bulk_delete_response.py'
example: |-
api_fleet_bulk_delete_response = ams_models.ApiFleetBulkDeleteResponse.create(...)
'ApiFleetClaimByKeysReq@py.ams.mod':
id: 'ApiFleetClaimByKeysReq@py.ams.mod'
name: 'ApiFleetClaimByKeysReq'
type: 'model'
fields:
'claim_keys':
type: 'List[str]'
required: true
'regions':
type: 'List[str]'
required: true
'session_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_claim_by_keys_req.py'
example: |-
api_fleet_claim_by_keys_req = ams_models.ApiFleetClaimByKeysReq.create(...)
'ApiFleetClaimReq@py.ams.mod':
id: 'ApiFleetClaimReq@py.ams.mod'
name: 'ApiFleetClaimReq'
type: 'model'
fields:
'region':
type: 'str'
required: true
'session_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_claim_req.py'
example: |-
api_fleet_claim_req = ams_models.ApiFleetClaimReq.create(...)
'ApiFleetClaimResponse@py.ams.mod':
id: 'ApiFleetClaimResponse@py.ams.mod'
name: 'ApiFleetClaimResponse'
type: 'model'
fields:
'fleet_id':
type: 'str'
required: true
'ip':
type: 'str'
required: true
'ports':
type: 'Dict[str, int]'
required: true
'region':
type: 'str'
required: true
'server_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_claim_response.py'
example: |-
api_fleet_claim_response = ams_models.ApiFleetClaimResponse.create(...)
'ApiFleetCreateResponse@py.ams.mod':
id: 'ApiFleetCreateResponse@py.ams.mod'
name: 'ApiFleetCreateResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_create_response.py'
example: |-
api_fleet_create_response = ams_models.ApiFleetCreateResponse.create(...)
'ApiFleetGetResponse@py.ams.mod':
id: 'ApiFleetGetResponse@py.ams.mod'
name: 'ApiFleetGetResponse'
type: 'model'
fields:
'active':
type: 'bool'
required: true
'claim_keys':
type: 'List[str]'
required: true
'ds_host_configuration':
type: 'ApiDSHostConfiguration'
required: true
'fallback_fleet':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'image_deployment_profile':
type: 'ApiImageDeploymentProfile'
required: true
'is_local':
type: 'bool'
required: true
'name':
type: 'str'
required: true
'on_demand':
type: 'bool'
required: true
'primary_fleet':
type: 'str'
required: true
'regions':
type: 'List[ApiRegionConfig]'
required: true
'sampling_rules':
type: 'ApiFleetArtifactsSampleRules'
required: true
'hibernate_after_period':
type: 'str'
required: false
description: |-
Maximum amount of time before an unused on-demand fleet is hibernated, e.g. '1h'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_get_response.py'
example: |-
api_fleet_get_response = ams_models.ApiFleetGetResponse.create(...)
'ApiFleetListItemResponse@py.ams.mod':
id: 'ApiFleetListItemResponse@py.ams.mod'
name: 'ApiFleetListItemResponse'
type: 'model'
fields:
'active':
type: 'bool'
required: true
'counts':
type: 'List[ApiFleetRegionalServerCounts]'
required: true
'fallback_fleet':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'image':
type: 'str'
required: true
'instance_provider':
type: 'str'
required: true
'is_local':
type: 'bool'
required: true
'name':
type: 'str'
required: true
'on_demand':
type: 'bool'
required: true
'primary_fleet':
type: 'str'
required: true
'regions':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_list_item_response.py'
example: |-
api_fleet_list_item_response = ams_models.ApiFleetListItemResponse.create(...)
'ApiFleetListResponse@py.ams.mod':
id: 'ApiFleetListResponse@py.ams.mod'
name: 'ApiFleetListResponse'
type: 'model'
fields:
'fleets':
type: 'List[ApiFleetListItemResponse]'
required: true
'paging':
type: 'PaginationPaginationInfo'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_list_response.py'
example: |-
api_fleet_list_response = ams_models.ApiFleetListResponse.create(...)
'ApiFleetParameters@py.ams.mod':
id: 'ApiFleetParameters@py.ams.mod'
name: 'ApiFleetParameters'
type: 'model'
fields:
'active':
type: 'bool'
required: true
'ds_host_configuration':
type: 'ApiDSHostConfigurationParameters'
required: true
'image_deployment_profile':
type: 'ApiImageDeploymentProfile'
required: true
'name':
type: 'str'
required: true
'on_demand':
type: 'bool'
required: true
'regions':
type: 'List[ApiRegionConfig]'
required: true
'claim_keys':
type: 'List[str]'
required: false
'fallback_fleet':
type: 'str'
required: false
'hibernate_after_period':
type: 'str'
required: false
description: |-
Amount of time before an unused on-demand fleet is hibernated, e.g. '1h'
'sampling_rules':
type: 'ApiFleetArtifactsSampleRules'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_parameters.py'
example: |-
api_fleet_parameters = ams_models.ApiFleetParameters.create(...)
'ApiFleetRegionalServerCounts@py.ams.mod':
id: 'ApiFleetRegionalServerCounts@py.ams.mod'
name: 'ApiFleetRegionalServerCounts'
type: 'model'
fields:
'claimed_server_count':
type: 'int'
required: true
'ready_server_count':
type: 'int'
required: true
'region':
type: 'str'
required: true
'running_vm_count':
type: 'int'
required: true
'target_ds_count':
type: 'int'
required: true
'target_vm_count':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_regional_server_counts.py'
example: |-
api_fleet_regional_server_counts = ams_models.ApiFleetRegionalServerCounts.create(...)
'ApiFleetServerConnectionInfoResponse@py.ams.mod':
id: 'ApiFleetServerConnectionInfoResponse@py.ams.mod'
name: 'ApiFleetServerConnectionInfoResponse'
type: 'model'
fields:
'expires_at':
type: 'str'
required: true
'host':
type: 'str'
required: true
'logstream_port':
type: 'int'
required: true
'secret':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_server_connection_info_response.py'
example: |-
api_fleet_server_connection_info_response = ams_models.ApiFleetServerConnectionInfoResponse.create(...)
'ApiFleetServerHistoryEventResponse@py.ams.mod':
id: 'ApiFleetServerHistoryEventResponse@py.ams.mod'
name: 'ApiFleetServerHistoryEventResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'exit_code':
type: 'int'
required: true
'fleet_id':
type: 'str'
required: true
'new_state':
type: 'str'
required: true
'old_state':
type: 'str'
required: true
'reason':
type: 'str'
required: true
'server_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_server_history_event_response.py'
example: |-
api_fleet_server_history_event_response = ams_models.ApiFleetServerHistoryEventResponse.create(...)
'ApiFleetServerHistoryResponse@py.ams.mod':
id: 'ApiFleetServerHistoryResponse@py.ams.mod'
name: 'ApiFleetServerHistoryResponse'
type: 'model'
fields:
'events':
type: 'List[ApiFleetServerHistoryEventResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_server_history_response.py'
example: |-
api_fleet_server_history_response = ams_models.ApiFleetServerHistoryResponse.create(...)
'ApiFleetServerInfoResponse@py.ams.mod':
id: 'ApiFleetServerInfoResponse@py.ams.mod'
name: 'ApiFleetServerInfoResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'fleet_id':
type: 'str'
required: true
'fleet_name':
type: 'str'
required: true
'image_cmd':
type: 'str'
required: true
'image_id':
type: 'str'
required: true
'instance_type':
type: 'str'
required: true
'ip_address':
type: 'str'
required: true
'port_configuration':
type: 'List[ApiPortConfiguration]'
required: true
'ports':
type: 'Dict[str, int]'
required: true
'region':
type: 'str'
required: true
'server_configuration':
type: 'str'
required: true
'server_id':
type: 'str'
required: true
'session_id':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_server_info_response.py'
example: |-
api_fleet_server_info_response = ams_models.ApiFleetServerInfoResponse.create(...)
'ApiFleetServersResponse@py.ams.mod':
id: 'ApiFleetServersResponse@py.ams.mod'
name: 'ApiFleetServersResponse'
type: 'model'
fields:
'paging':
type: 'ApiPagingInfo'
required: true
'regions':
type: 'List[ApiFleetRegionalServerCounts]'
required: true
'servers':
type: 'List[ApiFleetServerInfoResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_fleet_servers_response.py'
example: |-
api_fleet_servers_response = ams_models.ApiFleetServersResponse.create(...)
'ApiImageDeploymentProfile@py.ams.mod':
id: 'ApiImageDeploymentProfile@py.ams.mod'
name: 'ApiImageDeploymentProfile'
type: 'model'
fields:
'command_line':
type: 'str'
required: true
'image_id':
type: 'str'
required: true
'port_configurations':
type: 'List[ApiPortConfiguration]'
required: true
'timeout':
type: 'ApiTimeout'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_deployment_profile.py'
example: |-
api_image_deployment_profile = ams_models.ApiImageDeploymentProfile.create(...)
'ApiImageDetails@py.ams.mod':
id: 'ApiImageDetails@py.ams.mod'
name: 'ApiImageDetails'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'executable':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'is_protected':
type: 'bool'
required: true
'name':
type: 'str'
required: true
'referencing_fleets':
type: 'List[ApiReferencingFleet]'
required: true
'size_in_byte':
type: 'int'
required: true
'status':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'target_architecture':
type: 'str'
required: true
'uploaded_at':
type: 'str'
required: true
'uploaded_by':
type: 'str'
required: true
'delete_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_details.py'
example: |-
api_image_details = ams_models.ApiImageDetails.create(...)
'ApiImageList@py.ams.mod':
id: 'ApiImageList@py.ams.mod'
name: 'ApiImageList'
type: 'model'
fields:
'images':
type: 'List[ApiImageListItem]'
required: true
'paging':
type: 'ApiPagingInfo'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_list.py'
example: |-
api_image_list = ams_models.ApiImageList.create(...)
'ApiImageListItem@py.ams.mod':
id: 'ApiImageListItem@py.ams.mod'
name: 'ApiImageListItem'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'executable':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'is_protected':
type: 'bool'
required: true
'name':
type: 'str'
required: true
'referencing_configs':
type: 'int'
required: true
'referencing_fleets':
type: 'int'
required: true
'size_in_byte':
type: 'int'
required: true
'status':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'target_architecture':
type: 'str'
required: true
'uploaded_at':
type: 'str'
required: true
'uploaded_by':
type: 'str'
required: true
'delete_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_list_item.py'
example: |-
api_image_list_item = ams_models.ApiImageListItem.create(...)
'ApiImageStorage@py.ams.mod':
id: 'ApiImageStorage@py.ams.mod'
name: 'ApiImageStorage'
type: 'model'
fields:
'current_marked_for_deletion_bytes':
type: 'int'
required: true
'current_usage_bytes':
type: 'int'
required: true
'quota_bytes':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_storage.py'
example: |-
api_image_storage = ams_models.ApiImageStorage.create(...)
'ApiImageUpdate@py.ams.mod':
id: 'ApiImageUpdate@py.ams.mod'
name: 'ApiImageUpdate'
type: 'model'
fields:
'added_tags':
type: 'List[str]'
required: true
'removed_tags':
type: 'List[str]'
required: true
'is_protected':
type: 'bool'
required: false
'name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_image_update.py'
example: |-
api_image_update = ams_models.ApiImageUpdate.create(...)
'ApiInstanceType@py.ams.mod':
id: 'ApiInstanceType@py.ams.mod'
name: 'ApiInstanceType'
type: 'model'
fields:
'capacity':
type: 'List[ApiCapacity]'
required: true
'description':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'is_baremetal':
type: 'bool'
required: true
'memory_gi_b':
type: 'float'
required: true
'min_speed':
type: 'str'
required: true
'name':
type: 'str'
required: true
'owner_account_id':
type: 'str'
required: true
'processor_architecture':
type: 'str'
required: true
'provider':
type: 'str'
required: true
'virtual_cpu':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_instance_type.py'
example: |-
api_instance_type = ams_models.ApiInstanceType.create(...)
'ApiInstanceTypesResponse@py.ams.mod':
id: 'ApiInstanceTypesResponse@py.ams.mod'
name: 'ApiInstanceTypesResponse'
type: 'model'
fields:
'available_instance_types':
type: 'List[ApiInstanceType]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_instance_types_response.py'
example: |-
api_instance_types_response = ams_models.ApiInstanceTypesResponse.create(...)
'ApiPagingInfo@py.ams.mod':
id: 'ApiPagingInfo@py.ams.mod'
name: 'ApiPagingInfo'
type: 'model'
fields:
'current_page':
type: 'int'
required: true
'has_next':
type: 'bool'
required: true
'has_pages':
type: 'bool'
required: true
'has_prev':
type: 'bool'
required: true
'next_':
type: 'str'
required: true
'page_nums':
type: 'List[int]'
required: true
'previous':
type: 'str'
required: true
'total':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_paging_info.py'
example: |-
api_paging_info = ams_models.ApiPagingInfo.create(...)
'ApiPortConfiguration@py.ams.mod':
id: 'ApiPortConfiguration@py.ams.mod'
name: 'ApiPortConfiguration'
type: 'model'
fields:
'name':
type: 'str'
required: true
'protocol':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_port_configuration.py'
example: |-
api_port_configuration = ams_models.ApiPortConfiguration.create(...)
'ApiQoSEndpointResponse@py.ams.mod':
id: 'ApiQoSEndpointResponse@py.ams.mod'
name: 'ApiQoSEndpointResponse'
type: 'model'
fields:
'servers':
type: 'List[ApiQoSServer]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_qo_s_endpoint_response.py'
example: |-
api_qo_s_endpoint_response = ams_models.ApiQoSEndpointResponse.create(...)
'ApiQoSServer@py.ams.mod':
id: 'ApiQoSServer@py.ams.mod'
name: 'ApiQoSServer'
type: 'model'
fields:
'alias':
type: 'str'
required: true
'ip':
type: 'str'
required: true
'last_update':
type: 'str'
required: true
'port':
type: 'int'
required: true
'region':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_qo_s_server.py'
example: |-
api_qo_s_server = ams_models.ApiQoSServer.create(...)
'ApiReferencingFleet@py.ams.mod':
id: 'ApiReferencingFleet@py.ams.mod'
name: 'ApiReferencingFleet'
type: 'model'
fields:
'environment':
type: 'str'
required: true
'fleet_id':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_referencing_fleet.py'
example: |-
api_referencing_fleet = ams_models.ApiReferencingFleet.create(...)
'ApiRegionConfig@py.ams.mod':
id: 'ApiRegionConfig@py.ams.mod'
name: 'ApiRegionConfig'
type: 'model'
fields:
'buffer_size':
type: 'int'
required: true
'dynamic_buffer':
type: 'bool'
required: true
'max_server_count':
type: 'int'
required: true
'min_server_count':
type: 'int'
required: true
'region':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_region_config.py'
example: |-
api_region_config = ams_models.ApiRegionConfig.create(...)
'ApiTimeout@py.ams.mod':
id: 'ApiTimeout@py.ams.mod'
name: 'ApiTimeout'
type: 'model'
description: |-
Contains fleet timeout configuration. Fields accept duration strings (e.g. '30s', '1h30m'), an integer number of seconds.
fields:
'claim':
type: 'int'
required: false
description: |-
Maximum time allowed for the DS to be claimed after it is created. (e.g. '4h')
'creation':
type: 'int'
required: false
description: |-
Maximum time allowed for the DS to become ready. (e.g. '30s')
'drain':
type: 'int'
required: false
description: |-
Maximum time allowed for the DS to drain gracefully after a drain signal before being terminated. (e.g. '30s')
'session':
type: 'int'
required: false
description: |-
Maximum time the game session will be allowed to run, (e.g. '1h30m')
'unresponsive':
type: 'int'
required: false
description: |-
Maximum time allowed for the DS to be unresponsive before being terminated. (e.g. '1m')
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_timeout.py'
example: |-
api_timeout = ams_models.ApiTimeout.create(...)
'ApiUpdateServerRequest@py.ams.mod':
id: 'ApiUpdateServerRequest@py.ams.mod'
name: 'ApiUpdateServerRequest'
type: 'model'
fields:
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/api_update_server_request.py'
example: |-
api_update_server_request = ams_models.ApiUpdateServerRequest.create(...)
'PaginationPaginationInfo@py.ams.mod':
id: 'PaginationPaginationInfo@py.ams.mod'
name: 'PaginationPaginationInfo'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
'total':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/pagination_pagination_info.py'
example: |-
pagination_pagination_info = ams_models.PaginationPaginationInfo.create(...)
'ResponseErrorResponse@py.ams.mod':
id: 'ResponseErrorResponse@py.ams.mod'
name: 'ResponseErrorResponse'
type: 'model'
fields:
'error_message':
type: 'str'
required: true
'error_type':
type: 'str'
required: true
'trace_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/models/response_error_response.py'
example: |-
response_error_response = ams_models.ResponseErrorResponse.create(...)
# endregion models
# region functions
'account_get@py.ams.fun':
id: 'account_get@py.ams.fun'
name: 'account_get'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAccountResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/account/account_get.py'
example: |-
result, error = ams.account_get(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'get'
'admin_account_create@py.ams.fun':
id: 'admin_account_create@py.ams.fun'
name: 'admin_account_create'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
arguments:
'body':
type: 'ApiAccountCreateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAccountCreateResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/account/admin_account_create.py'
example: |-
result, error = ams.admin_account_create(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'create'
'admin_account_get@py.ams.fun':
id: 'admin_account_get@py.ams.fun'
name: 'admin_account_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAccountResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/account/admin_account_get.py'
example: |-
result, error = ams.admin_account_get(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'get'
'admin_account_link@py.ams.fun':
id: 'admin_account_link@py.ams.fun'
name: 'admin_account_link'
type: 'function'
description: |-
This route will attempt to register the account to namespace linkage in AMS and requires a valid account link token. This route fails if an account is already linked
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
arguments:
'body':
type: 'ApiAccountLinkRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAccountLinkResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/account/admin_account_link.py'
example: |-
result, error = ams.admin_account_link(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'link'
'admin_account_link_token_get@py.ams.fun':
id: 'admin_account_link_token_get@py.ams.fun'
name: 'admin_account_link_token_get'
type: 'function'
description: |-
The link token returned can be used to connect another namespace to the account in which the provided namespace is linked. This route fails if there is no account linked to the specified namespace.
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAccountLinkTokenResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/account/admin_account_link_token_get.py'
example: |-
result, error = ams.admin_account_link_token_get(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'get'
- 'link'
- 'token'
'artifact_bulk_delete@py.ams.fun':
id: 'artifact_bulk_delete@py.ams.fun'
name: 'artifact_bulk_delete'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
arguments:
'artifact_type':
type: 'Optional[str]'
required: false
description: |-
artifact type (can be repeated)
'fleet_id':
type: 'Optional[str]'
required: false
description: |-
fleet ID (can be repeated)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'uploaded_before':
type: 'Optional[str]'
required: false
description: |-
uploaded before date
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/artifact_bulk_delete.py'
example: |-
result, error = ams.artifact_bulk_delete(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'bulk'
- 'delete'
'artifact_delete@py.ams.fun':
id: 'artifact_delete@py.ams.fun'
name: 'artifact_delete'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
arguments:
'artifact_id':
type: 'str'
required: true
description: |-
the id of the artifact
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/artifact_delete.py'
example: |-
result, error = ams.artifact_delete(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'delete'
'artifact_get@py.ams.fun':
id: 'artifact_get@py.ams.fun'
name: 'artifact_get'
type: 'function'
description: |-
Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won't have been filtered on those parameters
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
arguments:
'artifact_type':
type: 'Optional[str]'
required: false
description: |-
one of: log, coredump
'count':
type: 'Optional[int]'
required: false
description: |-
defines the maximum number of records returned in one page.
'end_date':
type: 'Optional[str]'
required: false
description: |-
omit artifacts with collection dates newer than
'fleet_id':
type: 'Optional[str]'
required: false
description: |-
id of the fleet where the artifact was collected
'image_id':
type: 'Optional[str]'
required: false
description: |-
id of the image being used on the server when artifact was collected
'max_size':
type: 'Optional[int]'
required: false
description: |-
maximum artifact size in bytes
'min_size':
type: 'Optional[int]'
required: false
description: |-
minimum artifact size in bytes
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
specifies the start index for the records returned. Useful for implementing pagination.
'region':
type: 'Optional[str]'
required: false
description: |-
region of the server where the artifact was collected
'server_id':
type: 'Optional[str]'
required: false
description: |-
id of the server (ds) where the artifact was collected
'sort_by':
type: 'Optional[str]'
required: false
description: |-
field name to sort the artifact
'sort_direction':
type: 'Optional[Union[str, ArtifactGetSortDirectionEnum]]'
required: false
description: |-
the sort direction
'start_date':
type: 'Optional[str]'
required: false
description: |-
omit artifacts with collection dates older than
'status':
type: 'Optional[str]'
required: false
description: |-
one of: success, skipped_sample, skipped_usage, failed
return_type: 'Tuple[Union[None, ApiArtifactListResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/artifact_get.py'
example: |-
result, error = ams.artifact_get(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'get'
'artifact_get_url@py.ams.fun':
id: 'artifact_get_url@py.ams.fun'
name: 'artifact_get_url'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
arguments:
'artifact_id':
type: 'str'
required: true
description: |-
the id of the artifact
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiArtifactURLResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/artifact_get_url.py'
example: |-
result, error = ams.artifact_get_url(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'get'
- 'url'
'artifact_usage_get@py.ams.fun':
id: 'artifact_usage_get@py.ams.fun'
name: 'artifact_usage_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiArtifactUsageResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/artifact_usage_get.py'
example: |-
result, error = ams.artifact_usage_get(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'get'
- 'usage'
'auth_check@py.ams.fun':
id: 'auth_check@py.ams.fun'
name: 'auth_check'
type: 'function'
description: |-
Check if fleet commander is authorized to talk to AMS with this IAM
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/auth/auth_check.py'
example: |-
result, error = ams.auth_check(...)
if error:
# handle_error(error)
tags:
- 'auth'
- 'check'
'basic_health_check@py.ams.fun':
id: 'basic_health_check@py.ams.fun'
name: 'basic_health_check'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleet_commander/basic_health_check.py'
example: |-
result, error = ams.basic_health_check(...)
if error:
# handle_error(error)
tags:
- 'basic'
- 'check'
- 'commander'
- 'fleet'
- 'health'
'bulk_fleet_delete@py.ams.fun':
id: 'bulk_fleet_delete@py.ams.fun'
name: 'bulk_fleet_delete'
type: 'function'
description: |-
Maximum of 1000 fleets allowed
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
arguments:
'body':
type: 'ApiFleetBulkDeleteRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetBulkDeleteResponse], Union[None, ApiFleetBulkDeleteResponse, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/bulk_fleet_delete.py'
example: |-
result, error = ams.bulk_fleet_delete(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'delete'
- 'fleet'
- 'fleets'
'development_server_configuration_create@py.ams.fun':
id: 'development_server_configuration_create@py.ams.fun'
name: 'development_server_configuration_create'
type: 'function'
description: |-
Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
arguments:
'body':
type: 'ApiDevelopmentServerConfigurationCreateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiDevelopmentServerConfigurationCreateResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/development/development_server_conf_a8e4dd.py'
example: |-
result, error = ams.development_server_configuration_create(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'create'
- 'development'
- 'server'
'development_server_configuration_delete@py.ams.fun':
id: 'development_server_configuration_delete@py.ams.fun'
name: 'development_server_configuration_delete'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
arguments:
'development_server_config_id':
type: 'str'
required: true
description: |-
the name of the development server configuration
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/development/development_server_conf_2194f5.py'
example: |-
result, error = ams.development_server_configuration_delete(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'delete'
- 'development'
- 'server'
'development_server_configuration_get@py.ams.fun':
id: 'development_server_configuration_get@py.ams.fun'
name: 'development_server_configuration_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'development_server_config_id':
type: 'str'
required: true
description: |-
the name of the development server configuration
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiDevelopmentServerConfigurationGetResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/development/development_server_conf_282185.py'
example: |-
result, error = ams.development_server_configuration_get(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'development'
- 'get'
- 'server'
'development_server_configuration_list@py.ams.fun':
id: 'development_server_configuration_list@py.ams.fun'
name: 'development_server_configuration_list'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'count':
type: 'Optional[int]'
required: false
description: |-
defines the maximum number of records returned in one page.
'image_id':
type: 'Optional[str]'
required: false
description: |-
filter by image ID
'name':
type: 'Optional[str]'
required: false
description: |-
filter by config name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
specifies the start index for the records returned.
'sort_by':
type: 'Optional[Union[str, DevelopmentServerConfigurationListSortByEnum]]'
required: false
description: |-
sort records by the given field
'sort_direction':
type: 'Optional[Union[str, DevelopmentServerConfigurationListSortDirectionEnum]]'
required: false
description: |-
sort direction (ascending or descending)
return_type: 'Tuple[Union[None, ApiDevelopmentServerConfigurationListResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/development/development_server_conf_7b687b.py'
example: |-
result, error = ams.development_server_configuration_list(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'development'
- 'list'
- 'server'
'development_server_configuration_patch@py.ams.fun':
id: 'development_server_configuration_patch@py.ams.fun'
name: 'development_server_configuration_patch'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
arguments:
'body':
type: 'ApiDevelopmentServerConfigurationUpdateRequest'
required: true
'development_server_config_id':
type: 'str'
required: true
description: |-
the name of the development server configuration
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/development/development_server_conf_a0c52c.py'
example: |-
result, error = ams.development_server_configuration_patch(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'development'
- 'patch'
- 'server'
'fleet_artifact_sampling_rules_get@py.ams.fun':
id: 'fleet_artifact_sampling_rules_get@py.ams.fun'
name: 'fleet_artifact_sampling_rules_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
arguments:
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetArtifactsSampleRules], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/fleet_artifact_sampling_739743.py'
example: |-
result, error = ams.fleet_artifact_sampling_rules_get(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'fleet'
- 'get'
- 'rules'
- 'sampling'
'fleet_artifact_sampling_rules_set@py.ams.fun':
id: 'fleet_artifact_sampling_rules_set@py.ams.fun'
name: 'fleet_artifact_sampling_rules_set'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
arguments:
'body':
type: 'ApiFleetArtifactsSampleRules'
required: true
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetArtifactsSampleRules], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/artifacts/fleet_artifact_sampling_a22d2b.py'
example: |-
result, error = ams.fleet_artifact_sampling_rules_set(...)
if error:
# handle_error(error)
tags:
- 'artifact'
- 'artifacts'
- 'fleet'
- 'rules'
- 'sampling'
- 'set'
'fleet_claim_by_id@py.ams.fun':
id: 'fleet_claim_by_id@py.ams.fun'
name: 'fleet_claim_by_id'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
arguments:
'body':
type: 'ApiFleetClaimReq'
required: true
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetClaimResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_claim_by_id.py'
example: |-
result, error = ams.fleet_claim_by_id(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'claim'
- 'fleet'
- 'fleets'
- 'id'
'fleet_claim_by_keys@py.ams.fun':
id: 'fleet_claim_by_keys@py.ams.fun'
name: 'fleet_claim_by_keys'
type: 'function'
description: |-
Claim a dedicated server from fleets with matching claim keys.
If the claim key is for a regular fleet (non development), the request will instantly fail if there are no DS available (HTTP 404).
If the claim key is for a development fleet and there are no DS available, a new DS will be launched and the request might take up to 8 seconds to return (depending on the environment configuration). If it's not ready after that duration the request will still return HTTP 404. In either case, the call to this endpoint may be retried at any time to check if a DS has become available.
Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
arguments:
'body':
type: 'ApiFleetClaimByKeysReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetClaimResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_claim_by_keys.py'
example: |-
result, error = ams.fleet_claim_by_keys(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'claim'
- 'fleet'
- 'fleets'
- 'keys'
'fleet_create@py.ams.fun':
id: 'fleet_create@py.ams.fun'
name: 'fleet_create'
type: 'function'
description: |-
Optionally, sampling rules for the fleet can also be specified
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
arguments:
'body':
type: 'ApiFleetParameters'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetCreateResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_create.py'
example: |-
result, error = ams.fleet_create(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'fleet'
- 'fleets'
'fleet_delete@py.ams.fun':
id: 'fleet_delete@py.ams.fun'
name: 'fleet_delete'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
arguments:
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_delete.py'
example: |-
result, error = ams.fleet_delete(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'fleet'
- 'fleets'
'fleet_get@py.ams.fun':
id: 'fleet_get@py.ams.fun'
name: 'fleet_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiFleetGetResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_get.py'
example: |-
result, error = ams.fleet_get(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'fleets'
- 'get'
'fleet_list@py.ams.fun':
id: 'fleet_list@py.ams.fun'
name: 'fleet_list'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'active':
type: 'Optional[bool]'
required: false
description: |-
filter fleets by active status
'count':
type: 'Optional[int]'
required: false
description: |-
the number of fleets to return
'name':
type: 'Optional[str]'
required: false
description: |-
filter fleets by name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
the pagination offset
'region':
type: 'Optional[str]'
required: false
description: |-
filter fleets by region
'sort_by':
type: 'Optional[Union[str, FleetListSortByEnum]]'
required: false
description: |-
sort fleets by column name
'sort_direction':
type: 'Optional[Union[str, FleetListSortDirectionEnum]]'
required: false
description: |-
sort direction (ascending or descending)
return_type: 'Tuple[Union[None, ApiFleetListResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_list.py'
example: |-
result, error = ams.fleet_list(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'fleets'
- 'list'
'fleet_server_connection_info@py.ams.fun':
id: 'fleet_server_connection_info@py.ams.fun'
name: 'fleet_server_connection_info'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'server_id':
type: 'str'
required: true
description: |-
the ID of the dedicated server
return_type: 'Tuple[Union[None, ApiFleetServerConnectionInfoResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/servers/fleet_server_connection_info.py'
example: |-
result, error = ams.fleet_server_connection_info(...)
if error:
# handle_error(error)
tags:
- 'connection'
- 'fleet'
- 'info'
- 'server'
- 'servers'
'fleet_server_history@py.ams.fun':
id: 'fleet_server_history@py.ams.fun'
name: 'fleet_server_history'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'count':
type: 'Optional[int]'
required: false
description: |-
Defines the maximum number of records returned in one page. Default is 1000 when not provided.
'fleet_id':
type: 'str'
required: true
description: |-
ID of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
Specifies the start index for the records returned. Useful for implementing pagination. Default is 0 when not provided.
'reason':
type: 'Optional[str]'
required: false
description: |-
Exit reason
'region':
type: 'Optional[str]'
required: false
description: |-
Region
'server_id':
type: 'Optional[str]'
required: false
description: |-
Dedicated server ID
'sort_direction':
type: 'Optional[str]'
required: false
description: |-
The direction of the sort on the 'createdAt' column, 'asc' for ascending and 'desc' for descending. Defaults to 'asc' when not provided.
'status':
type: 'Optional[str]'
required: false
description: |-
Status of the dedicated server
return_type: 'Tuple[Union[None, ApiDSHistoryList], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/servers/fleet_server_history.py'
example: |-
result, error = ams.fleet_server_history(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'history'
- 'server'
- 'servers'
'fleet_server_info@py.ams.fun':
id: 'fleet_server_info@py.ams.fun'
name: 'fleet_server_info'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'server_id':
type: 'str'
required: true
description: |-
the id of the dedicated server
return_type: 'Tuple[Union[None, ApiFleetServerInfoResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/servers/fleet_server_info.py'
example: |-
result, error = ams.fleet_server_info(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'info'
- 'server'
- 'servers'
'fleet_servers@py.ams.fun':
id: 'fleet_servers@py.ams.fun'
name: 'fleet_servers'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'count':
type: 'Optional[int]'
required: false
description: |-
the data limit
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
the data offset
'region':
type: 'Optional[str]'
required: false
description: |-
the servers region
'server_id':
type: 'Optional[str]'
required: false
description: |-
the id of the server
'sort_by':
type: 'Optional[str]'
required: false
description: |-
the field by which to order the data
'sort_direction':
type: 'Optional[Union[str, FleetServersSortDirectionEnum]]'
required: false
description: |-
the data ordering direction
'status':
type: 'Optional[Union[str, FleetServersStatusEnum]]'
required: false
description: |-
the servers status
return_type: 'Tuple[Union[None, ApiFleetServersResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_servers.py'
example: |-
result, error = ams.fleet_servers(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'fleets'
- 'servers'
'fleet_update@py.ams.fun':
id: 'fleet_update@py.ams.fun'
name: 'fleet_update'
type: 'function'
description: |-
Optionally, sampling rules for the fleet can also be updated
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
arguments:
'body':
type: 'ApiFleetParameters'
required: true
'fleet_id':
type: 'str'
required: true
description: |-
the id of the fleet
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleets/fleet_update.py'
example: |-
result, error = ams.fleet_update(...)
if error:
# handle_error(error)
tags:
- 'fleet'
- 'fleets'
- 'update'
'func1@py.ams.fun':
id: 'func1@py.ams.fun'
name: 'func1'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleet_commander/func1.py'
example: |-
result, error = ams.func1(...)
if error:
# handle_error(error)
tags:
- 'commander'
- 'fleet'
- 'func1'
'image_get@py.ams.fun':
id: 'image_get@py.ams.fun'
name: 'image_get'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
arguments:
'image_id':
type: 'str'
required: true
description: |-
the id of the image
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiImageDetails], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/image_get.py'
example: |-
result, error = ams.image_get(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'image'
- 'images'
'image_list@py.ams.fun':
id: 'image_list@py.ams.fun'
name: 'image_list'
type: 'function'
description: |-
Returns images which exist (uploaded, uploading, or building) in the linked account. This route fails if no account is linked
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
arguments:
'count':
type: 'Optional[int]'
required: false
description: |-
the count of image list
'in_use':
type: 'Optional[str]'
required: false
description: |-
the inUse filter
'is_protected':
type: 'Optional[bool]'
required: false
description: |-
the image protected
'name':
type: 'Optional[str]'
required: false
description: |-
the image name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
the offset of image list
'sort_by':
type: 'Optional[str]'
required: false
description: |-
the sortBy parameter specifies the attribute by which to sort the results
'sort_direction':
type: 'Optional[str]'
required: false
description: |-
the sort direction parameter
'status':
type: 'Optional[str]'
required: false
description: |-
the image status
'tag':
type: 'Optional[str]'
required: false
description: |-
the image tag
'target_architecture':
type: 'Optional[str]'
required: false
description: |-
the target architecture (currently only 'linux-x86_64' and 'linux-arm_64' are supported)
return_type: 'Tuple[Union[None, ApiImageList], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/image_list.py'
example: |-
result, error = ams.image_list(...)
if error:
# handle_error(error)
tags:
- 'image'
- 'images'
- 'list'
'image_mark_for_deletion@py.ams.fun':
id: 'image_mark_for_deletion@py.ams.fun'
name: 'image_mark_for_deletion'
type: 'function'
description: |-
Marks an image for deletion. The image will stop being available for fleets and will eventually be deleted.
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
arguments:
'image_id':
type: 'str'
required: true
description: |-
the id of the image
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/image_mark_for_deletion.py'
example: |-
result, error = ams.image_mark_for_deletion(...)
if error:
# handle_error(error)
tags:
- 'deletion'
- 'for'
- 'image'
- 'images'
- 'mark'
'image_patch@py.ams.fun':
id: 'image_patch@py.ams.fun'
name: 'image_patch'
type: 'function'
description: |-
This allows editing of the image name, toggling `IsProtected`, or adding & removal of tags
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
arguments:
'body':
type: 'ApiImageUpdate'
required: true
'image_id':
type: 'str'
required: true
description: |-
the id of the image
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiImageDetails], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/image_patch.py'
example: |-
result, error = ams.image_patch(...)
if error:
# handle_error(error)
tags:
- 'image'
- 'images'
- 'patch'
'images_storage@py.ams.fun':
id: 'images_storage@py.ams.fun'
name: 'images_storage'
type: 'function'
description: |-
Returns information regarding the account's usage for images storage including the free tier quota
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiImageStorage], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/images_storage.py'
example: |-
result, error = ams.images_storage(...)
if error:
# handle_error(error)
tags:
- 'images'
- 'storage'
'image_unmark_for_deletion@py.ams.fun':
id: 'image_unmark_for_deletion@py.ams.fun'
name: 'image_unmark_for_deletion'
type: 'function'
description: |-
Unmarks an image for deletion. The image will be available for fleets.
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
arguments:
'image_id':
type: 'str'
required: true
description: |-
the id of the image
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/images/image_unmark_for_deletion.py'
example: |-
result, error = ams.image_unmark_for_deletion(...)
if error:
# handle_error(error)
tags:
- 'deletion'
- 'for'
- 'image'
- 'images'
- 'unmark'
'info_regions@py.ams.fun':
id: 'info_regions@py.ams.fun'
name: 'info_regions'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiAMSRegionsResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/ams_info/info_regions.py'
example: |-
result, error = ams.info_regions(...)
if error:
# handle_error(error)
tags:
- 'ams'
- 'info'
- 'regions'
'info_supported_instances@py.ams.fun':
id: 'info_supported_instances@py.ams.fun'
name: 'info_supported_instances'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiInstanceTypesResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/ams_info/info_supported_instances.py'
example: |-
result, error = ams.info_supported_instances(...)
if error:
# handle_error(error)
tags:
- 'ams'
- 'info'
- 'instances'
- 'supported'
'local_watchdog_connect@py.ams.fun':
id: 'local_watchdog_connect@py.ams.fun'
name: 'local_watchdog_connect'
type: 'function'
description: |-
This is to support local ds development scenarios
Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'watchdog_id':
type: 'str'
required: true
description: |-
the id of the watchdog
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/watchdogs/local_watchdog_connect.py'
example: |-
result, error = ams.local_watchdog_connect(...)
if error:
# handle_error(error)
tags:
- 'connect'
- 'local'
- 'watchdog'
- 'watchdogs'
'portal_health_check@py.ams.fun':
id: 'portal_health_check@py.ams.fun'
name: 'portal_health_check'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/fleet_commander/portal_health_check.py'
example: |-
result, error = ams.portal_health_check(...)
if error:
# handle_error(error)
tags:
- 'check'
- 'commander'
- 'fleet'
- 'health'
- 'portal'
'qo_s_regions_get@py.ams.fun':
id: 'qo_s_regions_get@py.ams.fun'
name: 'qo_s_regions_get'
type: 'function'
description: |-
```
Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [READ]
This endpoint lists all QoS services available in all regions.
This endpoint is intended to be called by game client to find out all available regions.
After getting a list of QoS on each region, game client is expected to ping each one with UDP
connection as described below:
1. Make UDP connection to each QoS's IP:Port
2. Send string "PING" after connection established
3. Wait for string "PONG" response
4. Note the request-response latency for each QoS in each region
The game then can use ping latency information to either:
1. Inform the player on these latencies and let player choose preferred region
2. Send the latency list to Matchmaking Service so that player can be matched with other players
in nearby regions
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'status':
type: 'Optional[str]'
required: false
description: |-
QoS status, available value: ACTIVE, INACTIVE
return_type: 'Tuple[Union[None, ApiQoSEndpointResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/ams_qo_s/qo_s_regions_get.py'
example: |-
result, error = ams.qo_s_regions_get(...)
if error:
# handle_error(error)
tags:
- 'ams'
- 'get'
- 'qo'
- 'regions'
- 's'
'qo_s_regions_update@py.ams.fun':
id: 'qo_s_regions_update@py.ams.fun'
name: 'qo_s_regions_update'
type: 'function'
description: |-
```
Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE]
This endpoint updates the registered QoS service's configurable configuration.
arguments:
'body':
type: 'ApiUpdateServerRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'region':
type: 'str'
required: true
description: |-
region of the QoS
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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/ams_qo_s/qo_s_regions_update.py'
example: |-
result, error = ams.qo_s_regions_update(...)
if error:
# handle_error(error)
tags:
- 'ams'
- 'qo'
- 'regions'
- 's'
- 'update'
'server_history@py.ams.fun':
id: 'server_history@py.ams.fun'
name: 'server_history'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'server_id':
type: 'str'
required: true
description: |-
the id of the dedicated server
return_type: 'Tuple[Union[None, ApiFleetServerHistoryResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/servers/server_history.py'
example: |-
result, error = ams.server_history(...)
if error:
# handle_error(error)
tags:
- 'history'
- 'server'
- 'servers'
'upload_url_get@py.ams.fun':
id: 'upload_url_get@py.ams.fun'
name: 'upload_url_get'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/ams_info/upload_url_get.py'
example: |-
result, error = ams.upload_url_get(...)
if error:
# handle_error(error)
tags:
- 'ams'
- 'get'
- 'info'
- 'upload'
- 'url'
'watchdog_connect@py.ams.fun':
id: 'watchdog_connect@py.ams.fun'
name: 'watchdog_connect'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'watchdog_id':
type: 'str'
required: true
description: |-
the id of the watchdog
return_type: 'Tuple[Union[None, HttpResponse], 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.ams as ams'
- 'import accelbyte_py_sdk.api.ams.models as ams_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/ams/operations/watchdogs/watchdog_connect.py'
example: |-
result, error = ams.watchdog_connect(...)
if error:
# handle_error(error)
tags:
- 'connect'
- 'watchdog'
- 'watchdogs'
# endregion functions
