+
+ +
+

pulumi_esc_sdk

+

ESC (Environments, Secrets, Config) API

+

Pulumi ESC allows you to compose and manage hierarchical collections of configuration and secrets and consume them in various ways.

+

The version of the OpenAPI document: 0.1.0 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+
+
+class pulumi_esc_sdk.Access(*, receiver: Range | None = None, accessors: List[Accessor] | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Access from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Access from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Accessor(*, index: int | None = None, key: str, range: Range)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Accessor from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Accessor from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+exception pulumi_esc_sdk.ApiAttributeError(msg, path_to_item=None)
+

Raised when an attribute reference or assignment fails.

+
+
Args:

msg (str): the exception message

+
+
Keyword Args:
+
path_to_item (None/list) the path to the exception in the

received_data dict

+
+
+
+
+
+ +
+
+class pulumi_esc_sdk.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)
+

Generic API client for OpenAPI client library builds.

+

OpenAPI generic API client. This client handles the client- +server communication, and is invariant across implementations. Specifics of +the methods and models for each application are generated from the OpenAPI +templates.

+
+
Parameters:
+
    +

  • configuration – .Configuration object for this client

    • +

  • header_name – a header to pass when making calls to the API.

    • +

  • header_value – a header value to pass when making calls to +the API.

    • +

  • cookie – a cookie to include in the header when making calls +to the API

    • +
+
+
+
+
+call_api(method, url, header_params=None, body=None, post_params=None, _request_timeout=None) → RESTResponse
+

Makes the HTTP request (synchronous) +:param method: Method to call. +:param url: Path to method endpoint. +:param header_params: Header parameters to be

+
+

placed in the request header.

+
+
+
Parameters:
+
    +

  • body – Request body.

    • +

  • dict (post_params) – Request post form parameters, +for application/x-www-form-urlencoded, multipart/form-data.

    • +

  • _request_timeout – timeout setting for this request.

    • +
+
+
Returns:
+

RESTResponse

+
+
+
+ +
+
+deserialize(response_text, response_type, content_type='application/json')
+

Deserializes response into an object.

+
+
Parameters:
+
    +

  • response – RESTResponse object to be deserialized.

    • +

  • response_type – class literal for +deserialized object, or string of class name.

    • +
+
+
Returns:
+

deserialized object.

+
+
+
+ +
+
+files_parameters(files=None)
+

Builds form parameters.

+
+
Parameters:
+

files – File parameters.

+
+
Returns:
+

Form parameters with files.

+
+
+
+ +
+
+classmethod get_default()
+

Return new instance of ApiClient.

+

This method returns newly created, based on default constructor, +object of ApiClient class or returns a copy of default +ApiClient.

+
+
Returns:
+

The ApiClient object.

+
+
+
+ +
+
+param_serialize(method, resource_path, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, auth_settings=None, collection_formats=None, _host=None, _request_auth=None) → Tuple[str, str, Dict[str, str], str | None, List[str]]
+

Builds the HTTP request params needed by the request. +:param method: Method to call. +:param resource_path: Path to method endpoint. +:param path_params: Path parameters in the url. +:param query_params: Query parameters in the url. +:param header_params: Header parameters to be

+
+

placed in the request header.

+
+
+
Parameters:
+
    +

  • body – Request body.

    • +

  • dict (files) – Request post form parameters, +for application/x-www-form-urlencoded, multipart/form-data.

    • +

  • list (auth_settings) – Auth Settings names for the request.

    • +

  • dict – key -> filename, value -> filepath, +for multipart/form-data.

    • +

  • collection_formats – dict of collection formats for path, query, +header, and post parameters.

    • +

  • _request_auth – set to override the auth_settings for an a single +request; this effectively ignores the authentication +in the spec for a single request.

    • +
+
+
Returns:
+

tuple of form (path, http_method, query_params, header_params, +body, post_params, files)

+
+
+
+ +
+
+parameters_to_tuples(params, collection_formats)
+

Get parameters as list of tuples, formatting collections.

+
+
Parameters:
+
    +

  • params – Parameters as dict or list of two-tuples

    • +

  • collection_formats (dict) – Parameter collection formats

    • +
+
+
Returns:
+

Parameters as list of tuples, collections formatted

+
+
+
+ +
+
+parameters_to_url_query(params, collection_formats)
+

Get parameters as list of tuples, formatting collections.

+
+
Parameters:
+
    +

  • params – Parameters as dict or list of two-tuples

    • +

  • collection_formats (dict) – Parameter collection formats

    • +
+
+
Returns:
+

URL query string (e.g. a=Hello%20World&b=123)

+
+
+
+ +
+
+response_deserialize(response_data: RESTResponse, response_types_map: Dict[str, T] | None = None) → ApiResponse
+

Deserializes response into an object. +:param response_data: RESTResponse object to be deserialized. +:param response_types_map: dict of response types. +:return: ApiResponse

+
+ +
+
+sanitize_for_serialization(obj)
+

Builds a JSON POST object.

+

If obj is None, return None. +If obj is str, int, long, float, bool, return directly. +If obj is datetime.datetime, datetime.date

+
+

convert to string in iso8601 format.

+
+

If obj is list, sanitize each element in the list. +If obj is dict, return the dict. +If obj is OpenAPI model, return the properties dict.

+
+
Parameters:
+

obj – The data to serialize.

+
+
Returns:
+

The serialized form of data.

+
+
+
+ +
+
+select_header_accept(accepts: List[str]) → str | None
+

Returns Accept based on an array of accepts provided.

+
+
Parameters:
+

accepts – List of headers.

+
+
Returns:
+

Accept (e.g. application/json).

+
+
+
+ +
+
+select_header_content_type(content_types)
+

Returns Content-Type based on an array of content_types provided.

+
+
Parameters:
+

content_types – List of content-types.

+
+
Returns:
+

Content-Type (e.g. application/json).

+
+
+
+ +
+
+classmethod set_default(default)
+

Set default instance of ApiClient.

+

It stores default ApiClient.

+
+
Parameters:
+

default – object of ApiClient.

+
+
+
+ +
+
+update_params_for_auth(headers, queries, auth_settings, resource_path, method, body, request_auth=None) → None
+

Updates header and query params based on authentication setting.

+
+
Parameters:
+
    +

  • headers – Header parameters dict to be updated.

    • +

  • queries – Query parameters tuple list to be updated.

    • +

  • auth_settings – Authentication setting identifiers list.

    • +
+
+
Resource_path:
+

A string representation of the HTTP request resource path.

+
+
Method:
+

A string representation of the HTTP request method.

+
+
Body:
+

A object representing the body of the HTTP request.

+
+
+

The object type is the return value of sanitize_for_serialization(). +:param request_auth: if set, the provided settings will

+
+

override the token in the configuration.

+
+
+ +
+
+property user_agent
+

User agent for this API client

+
+ +
+ +
+
+exception pulumi_esc_sdk.ApiException(status=None, reason=None, http_resp=None, *, body: str | None = None, data: Any | None = None)
+
+ +
+
+exception pulumi_esc_sdk.ApiKeyError(msg, path_to_item=None)
+
+
Args:

msg (str): the exception message

+
+
Keyword Args:
+
path_to_item (None/list) the path to the exception in the

received_data dict

+
+
+
+
+
+ +
+
+class pulumi_esc_sdk.ApiResponse(*, status_code: int, headers: Mapping[str, str] | None = None, data: T, raw_data: bytes)
+

API response object

+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+ +
+
+exception pulumi_esc_sdk.ApiTypeError(msg, path_to_item=None, valid_classes=None, key_type=None)
+

Raises an exception for TypeErrors

+
+
Args:

msg (str): the exception message

+
+
Keyword Args:
+
path_to_item (list): a list of keys an indices to get to the

current_item +None if unset

+
+
valid_classes (tuple): the primitive classes that current item

should be an instance of +None if unset

+
+
key_type (bool): False if our value is a value in a dict

True if it is a key in a dict +False if our item is an item in a list +None if unset

+
+
+
+
+
+ +
+
+exception pulumi_esc_sdk.ApiValueError(msg, path_to_item=None)
+
+
Args:

msg (str): the exception message

+
+
Keyword Args:
+
path_to_item (list) the path to the exception in the

received_data dict. None if unset

+
+
+
+
+
+ +
+
+class pulumi_esc_sdk.CheckEnvironment(*, exprs: Dict[str, Expr] | None = None, properties: Dict[str, Value] | None = None, schema: Any | None = None, executionContext: EvaluatedExecutionContext | None = None, diagnostics: List[EnvironmentDiagnostic] | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of CheckEnvironment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of CheckEnvironment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.CloneEnvironment(*, project: str, name: str, preserveAccess: bool | None = None, preserveEnvironmentTags: bool | None = None, preserveHistory: bool | None = None, preserveRevisionTags: bool | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of CloneEnvironment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of CloneEnvironment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+classmethod name_validate_regular_expression(value)
+

Validates the regular expression

+
+ +
+
+classmethod project_validate_regular_expression(value)
+

Validates the regular expression

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Configuration(host=None, access_token=None, server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, ssl_ca_cert=None)
+

This class contains various settings of the API client.

+
+
+
param host:
+

Base url.

+
+
param access_token:
+

Access token.

+
+
param server_index:
+

Index to servers configuration.

+
+
param server_variables:
+

Mapping with string values to replace variables in +templated server configuration. The validation of enums is performed for +variables with defined enum values before.

+
+
param server_operation_index:
+

Mapping from operation ID to an index to server +configuration.

+
+
param server_operation_variables:
+

Mapping from operation ID to a mapping with +string values to replace variables in templated server configuration. +The validation of enums is performed for variables with defined enum +values before.

+
+
param ssl_ca_cert:
+

str - the path to a file of concatenated CA certificates +in PEM format.

+
+
Example:
+

+
+

API Key Authentication Example. +Given the following security scheme in the OpenAPI specification:

+
+
+
components:
+
securitySchemes:
+
cookieAuth: # name for the security scheme

type: apiKey +in: cookie +name: JSESSIONID # cookie name

+
+
+
+
+
+
+
+

You can programmatically set the cookie:

+
+
+
conf = pulumi_esc_sdk.Configuration(

api_key={‘cookieAuth’: ‘abc123’} +api_key_prefix={‘cookieAuth’: ‘JSESSIONID’}

+
+
+

)

+
+
+
The following cookie will be added to the HTTP request:

Cookie: JSESSIONID abc123

+
+
+
+

Constructor

+
+
+assert_hostname
+

Set this to True/False to enable/disable SSL hostname verification.

+
+ +
+
+auth_settings()
+

Gets Auth Settings dict for api client.

+
+
Returns:
+

The Auth Settings information dict.

+
+
+
+ +
+
+cert_file
+

client certificate file

+
+ +
+
+connection_pool_maxsize
+

urllib3 connection pool’s maximum number of connections saved +per pool. urllib3 uses 1 connection as default value, but this is +not the best value when you are making a lot of possibly parallel +requests to the same host, which is often the case here. +cpu_count * 5 is used as default value to increase performance.

+
+ +
+
+date_format
+

date format

+
+ +
+
+datetime_format
+

datetime format

+
+ +
+
+property debug
+

Debug switch

+
+ +
+
+get_api_key_with_prefix(identifier, alias=None)
+

Gets API key (with prefix if set).

+
+
Parameters:
+
    +

  • identifier – The identifier of apiKey.

    • +

  • alias – The alternative identifier of apiKey.

    • +
+
+
Returns:
+

The token for api key authentication.

+
+
+
+ +
+
+get_basic_auth_token()
+

Gets HTTP basic authentication header (string).

+
+
Returns:
+

The token for basic HTTP authentication.

+
+
+
+ +
+
+classmethod get_default()
+

Return the default configuration.

+

This method returns newly created, based on default constructor, +object of Configuration class or returns a copy of default +configuration.

+
+
Returns:
+

The configuration object.

+
+
+
+ +
+
+classmethod get_default_copy()
+

Deprecated. Please use get_default instead.

+

Deprecated. Please use get_default instead.

+
+
Returns:
+

The configuration object.

+
+
+
+ +
+
+get_host_from_settings(index, variables=None, servers=None)
+

Gets host URL based on the index and variables +:param index: array index of the host settings +:param variables: hash of variable and the corresponding value +:param servers: an array of host settings or None +:return: URL based on host settings

+
+ +
+
+get_host_settings()
+

Gets an array of host settings

+
+
Returns:
+

An array of host settings

+
+
+
+ +
+
+property host
+

Return generated host.

+
+ +
+
+key_file
+

client key file

+
+ +
+
+logger
+

Logging Settings

+
+ +
+
+property logger_file
+

Debug file location

+
+ +
+
+logger_file_handler: FileHandler | None
+

Log file handler

+
+ +
+
+property logger_format
+

Log format

+
+ +
+
+logger_stream_handler
+

Log stream handler

+
+ +
+
+proxy: str | None
+

Proxy URL

+
+ +
+
+proxy_headers
+

Proxy headers

+
+ +
+
+refresh_api_key_hook
+

function hook to refresh API key if expired

+
+ +
+
+retries
+

Adding retries to override urllib3 default value 3

+
+ +
+
+safe_chars_for_path_param
+

Safe chars for path_param

+
+ +
+
+server_operation_index
+

Default server index

+
+ +
+
+server_operation_variables
+

Default server variables

+
+ +
+
+classmethod set_default(default)
+

Set default instance of configuration.

+

It stores default configuration, which can be +returned by get_default_copy method.

+
+
Parameters:
+

default – object of Configuration

+
+
+
+ +
+
+socket_options
+

Options to pass down to the underlying urllib3 socket

+
+ +
+
+ssl_ca_cert
+

Set this to customize the certificate file to verify the peer.

+
+ +
+
+temp_folder_path
+

Temp file folder for downloading files

+
+ +
+
+tls_server_name
+

SSL/TLS Server Name Indication (SNI) +Set this to the SNI value expected by the server.

+
+ +
+
+to_debug_report()
+

Gets the essential information for debugging.

+
+
Returns:
+

The report for debugging.

+
+
+
+ +
+
+verify_ssl
+

SSL/TLS verification +Set this to false to skip verifying SSL certificate when calling API +from https server.

+
+ +
+ +
+
+class pulumi_esc_sdk.CreateEnvironment(*, project: str, name: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of CreateEnvironment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of CreateEnvironment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+classmethod name_validate_regular_expression(value)
+

Validates the regular expression

+
+ +
+
+classmethod project_validate_regular_expression(value)
+

Validates the regular expression

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.CreateEnvironmentRevisionTag(*, name: str, revision: int)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of CreateEnvironmentRevisionTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of CreateEnvironmentRevisionTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.CreateEnvironmentTag(*, name: str, value: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of CreateEnvironmentTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of CreateEnvironmentTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Environment(*, exprs: Dict[str, Expr] | None = None, properties: Dict[str, Value] | None = None, schema: Any | None = None, executionContext: EvaluatedExecutionContext | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Environment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Environment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentDefinition(*, imports: List[str] | None = None, values: EnvironmentDefinitionValues | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentDefinition from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentDefinition from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentDefinitionValues(*, pulumiConfig: Dict[str, Any] | None = None, environmentVariables: Dict[str, str] | None = None, files: Dict[str, str] | None = None, additional_properties: Dict[str, Any] = {})
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentDefinitionValues from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentDefinitionValues from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +

  • Fields in self.additional_properties are added to the output dict.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentDiagnostic(*, summary: str, path: str | None = None, range: Range | None = None, additional_properties: Dict[str, Any] = {})
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentDiagnostic from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentDiagnostic from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +

  • Fields in self.additional_properties are added to the output dict.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentDiagnostics(*, diagnostics: List[EnvironmentDiagnostic] | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentDiagnostics from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentDiagnostics from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentRevision(*, number: int, creatorLogin: str | None = None, created: str | None = None, creatorName: str | None = None, tags: List[str] | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentRevision from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentRevision from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentRevisionTag(*, revision: int, name: str, created: str | None = None, modified: str | None = None, editorLogin: str | None = None, editorName: str | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentRevisionTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentRevisionTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentRevisionTags(*, tags: List[EnvironmentRevisionTag] | None = None, nextToken: str | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentRevisionTags from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentRevisionTags from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EnvironmentTag(*, name: str, value: str | None = None, created: str, modified: str, editorLogin: str, editorName: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EnvironmentTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EnvironmentTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Error(*, message: str, code: int)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Error from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Error from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.EscApi(api_client=None)
+

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+
+
+check_environment_yaml(org_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → CheckEnvironment
+

Checks an environment definition for errors

+

Checks an environment definition for errors

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+check_environment_yaml_with_http_info(org_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[CheckEnvironment]
+

Checks an environment definition for errors

+

Checks an environment definition for errors

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+check_environment_yaml_without_preload_content(org_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Checks an environment definition for errors

+

Checks an environment definition for errors

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+clone_environment(org_name: str, project_name: str, env_name: str, clone_environment: CloneEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Clones an environment

+

Clones an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • clone_environment (CloneEnvironment) – Clone environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+clone_environment_with_http_info(org_name: str, project_name: str, env_name: str, clone_environment: CloneEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Clones an environment

+

Clones an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • clone_environment (CloneEnvironment) – Clone environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+clone_environment_without_preload_content(org_name: str, project_name: str, env_name: str, clone_environment: CloneEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Clones an environment

+

Clones an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • clone_environment (CloneEnvironment) – Clone environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment(org_name: str, create_environment: CreateEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → Error
+

Create a new environment

+

Creates an environment in the given org with the given name.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • create_environment (CreateEnvironment) – Create Environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_revision_tag(org_name: str, project_name: str, env_name: str, create_environment_revision_tag: CreateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Create environment revision tag

+

Create environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_revision_tag (CreateEnvironmentRevisionTag) – Create environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_revision_tag_with_http_info(org_name: str, project_name: str, env_name: str, create_environment_revision_tag: CreateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Create environment revision tag

+

Create environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_revision_tag (CreateEnvironmentRevisionTag) – Create environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_revision_tag_without_preload_content(org_name: str, project_name: str, env_name: str, create_environment_revision_tag: CreateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Create environment revision tag

+

Create environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_revision_tag (CreateEnvironmentRevisionTag) – Create environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_tag(org_name: str, project_name: str, env_name: str, create_environment_tag: CreateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentTag
+

Create environment tag

+

Create environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_tag (CreateEnvironmentTag) – Create environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_tag_with_http_info(org_name: str, project_name: str, env_name: str, create_environment_tag: CreateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentTag]
+

Create environment tag

+

Create environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_tag (CreateEnvironmentTag) – Create environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_tag_without_preload_content(org_name: str, project_name: str, env_name: str, create_environment_tag: CreateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Create environment tag

+

Create environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • create_environment_tag (CreateEnvironmentTag) – Create environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_with_http_info(org_name: str, create_environment: CreateEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[Error]
+

Create a new environment

+

Creates an environment in the given org with the given name.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • create_environment (CreateEnvironment) – Create Environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+create_environment_without_preload_content(org_name: str, create_environment: CreateEnvironment, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Create a new environment

+

Creates an environment in the given org with the given name.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • create_environment (CreateEnvironment) – Create Environment (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+decrypt_environment(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentDefinition
+

Reads the definition for the given environment with static secrets in plaintext

+

Reads the definition for the given environment with static secrets in plaintext

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+decrypt_environment_with_http_info(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentDefinition]
+

Reads the definition for the given environment with static secrets in plaintext

+

Reads the definition for the given environment with static secrets in plaintext

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+decrypt_environment_without_preload_content(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Reads the definition for the given environment with static secrets in plaintext

+

Reads the definition for the given environment with static secrets in plaintext

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → Error
+

Delete an environment

+

Delete an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Delete environment revision tag

+

Delete environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_revision_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Delete environment revision tag

+

Delete environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_revision_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Delete environment revision tag

+

Delete environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Delete environment tag

+

Delete environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Delete environment tag

+

Delete environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Delete environment tag

+

Delete environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_with_http_info(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[Error]
+

Delete an environment

+

Delete an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+delete_environment_without_preload_content(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Delete an environment

+

Delete an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentDefinition
+

Read an environment

+

Read an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_at_version(org_name: str, project_name: str, env_name: str, version: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentDefinition
+

Read an environment at a specific version

+

Read an environmentat a specific revision or tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_at_version_with_http_info(org_name: str, project_name: str, env_name: str, version: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentDefinition]
+

Read an environment at a specific version

+

Read an environmentat a specific revision or tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_at_version_without_preload_content(org_name: str, project_name: str, env_name: str, version: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read an environment at a specific version

+

Read an environmentat a specific revision or tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_e_tag(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Return an Environment ETag

+

Returns the ETag for the given environment if it exists.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_e_tag_with_http_info(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Return an Environment ETag

+

Returns the ETag for the given environment if it exists.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_e_tag_without_preload_content(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Return an Environment ETag

+

Returns the ETag for the given environment if it exists.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentRevisionTag
+

Read environment revision tag

+

Read environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_revision_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentRevisionTag]
+

Read environment revision tag

+

Read environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_revision_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read environment revision tag

+

Read environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentTag
+

Read an environment tag

+

Read an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentTag]
+

Read an environment tag

+

Read an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read an environment tag

+

Read an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_with_http_info(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentDefinition]
+

Read an environment

+

Read an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+get_environment_without_preload_content(org_name: str, project_name: str, env_name: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read an environment

+

Read an environment

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revision_tags(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentRevisionTags
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revision_tags_with_http_info(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentRevisionTags]
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revision_tags_without_preload_content(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revisions(org_name: str, project_name: str, env_name: str, before: int | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → List[EnvironmentRevision]
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • before (int) – before revision number for pagination

    • +

  • count (int) – limit of revisions to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revisions_with_http_info(org_name: str, project_name: str, env_name: str, before: int | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[List[EnvironmentRevision]]
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • before (int) – before revision number for pagination

    • +

  • count (int) – limit of revisions to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_revisions_without_preload_content(org_name: str, project_name: str, env_name: str, before: int | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

List environment revisions

+

List environment revisions

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • before (int) – before revision number for pagination

    • +

  • count (int) – limit of revisions to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_tags(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ListEnvironmentTags
+

List environment tags

+

List environment tags

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_tags_with_http_info(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[ListEnvironmentTags]
+

List environment tags

+

List environment tags

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environment_tags_without_preload_content(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

List environment tags

+

List environment tags

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • after (str) – after tag for pagination

    • +

  • count (int) – limit of tags to return

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environments(org_name: str, continuation_token: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → OrgEnvironments
+

List environments in the organization

+

List environments in the organization available to the current user

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • continuation_token (str) – continuation Token from previous query to fetch next page of results

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environments_with_http_info(org_name: str, continuation_token: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[OrgEnvironments]
+

List environments in the organization

+

List environments in the organization available to the current user

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • continuation_token (str) – continuation Token from previous query to fetch next page of results

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+list_environments_without_preload_content(org_name: str, continuation_token: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

List environments in the organization

+

List environments in the organization available to the current user

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • continuation_token (str) – continuation Token from previous query to fetch next page of results

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment(org_name: str, project_name: str, env_name: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → OpenEnvironment
+

Open an environment session

+

Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment_at_version(org_name: str, project_name: str, env_name: str, version: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → OpenEnvironment
+

Open an environment session at a specific version

+

Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment_at_version_with_http_info(org_name: str, project_name: str, env_name: str, version: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[OpenEnvironment]
+

Open an environment session at a specific version

+

Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment_at_version_without_preload_content(org_name: str, project_name: str, env_name: str, version: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Open an environment session at a specific version

+

Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • version (str) – Revision or tag (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment_with_http_info(org_name: str, project_name: str, env_name: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[OpenEnvironment]
+

Open an environment session

+

Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+open_environment_without_preload_content(org_name: str, project_name: str, env_name: str, duration: str | None = None, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Open an environment session

+

Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • duration (str) – open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment(org_name: str, project_name: str, env_name: str, open_session_id: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → Environment
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment_property(org_name: str, project_name: str, env_name: str, open_session_id: str, var_property: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → Value
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • var_property (str) – Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment_property_with_http_info(org_name: str, project_name: str, env_name: str, open_session_id: str, var_property: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[Value]
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • var_property (str) – Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment_property_without_preload_content(org_name: str, project_name: str, env_name: str, open_session_id: str, var_property: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • var_property (str) – Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment_with_http_info(org_name: str, project_name: str, env_name: str, open_session_id: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[Environment]
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+read_open_environment_without_preload_content(org_name: str, project_name: str, env_name: str, open_session_id: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Read an open environment

+

Reads and decrypts secrets including retrieving dynamic secrets from providers.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • open_session_id (str) – Open session ID returned from environment open (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_revision_tag: UpdateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → None
+

Update environment revision tag

+

Update environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_revision_tag (UpdateEnvironmentRevisionTag) – Update environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_revision_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_revision_tag: UpdateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[NoneType]
+

Update environment revision tag

+

Update environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_revision_tag (UpdateEnvironmentRevisionTag) – Update environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_revision_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_revision_tag: UpdateEnvironmentRevisionTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Update environment revision tag

+

Update environment revision tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_revision_tag (UpdateEnvironmentRevisionTag) – Update environment revision tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_tag: UpdateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentTag
+

Update an environment tag

+

Update an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_tag (UpdateEnvironmentTag) – Update environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_tag_with_http_info(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_tag: UpdateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentTag]
+

Update an environment tag

+

Update an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_tag (UpdateEnvironmentTag) – Update environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_tag_without_preload_content(org_name: str, project_name: str, env_name: str, tag_name: str, update_environment_tag: UpdateEnvironmentTag, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Update an environment tag

+

Update an environment tag

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • tag_name (str) – Tag name (required)

    • +

  • update_environment_tag (UpdateEnvironmentTag) – Update environment tag (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_yaml(org_name: str, project_name: str, env_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → EnvironmentDiagnostics
+

Update an existing environment with Yaml file

+

Validates and updates the given environment’s definition.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_yaml_with_http_info(org_name: str, project_name: str, env_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → ApiResponse[EnvironmentDiagnostics]
+

Update an existing environment with Yaml file

+

Validates and updates the given environment’s definition.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+
+update_environment_yaml_without_preload_content(org_name: str, project_name: str, env_name: str, body: str, _request_timeout: None | float | Tuple[float, float] = None, _request_auth: Dict[str, Any] | None = None, _content_type: str | None = None, _headers: Dict[str, Any] | None = None, _host_index: int = 0) → HTTPResponse
+

Update an existing environment with Yaml file

+

Validates and updates the given environment’s definition.

+
+
Parameters:
+
    +

  • org_name (str) – Organization name (required)

    • +

  • project_name (str) – Project name (required)

    • +

  • env_name (str) – Environment name (required)

    • +

  • body (str) – Environment Yaml content (required)

    • +

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one +number provided, it will be total request +timeout. It can also be a pair (tuple) of +(connection, read) timeouts.

    • +

  • _request_auth (dict, optional) – set to override the auth_settings for an a single +request; this effectively ignores the +authentication in the spec for a single request.

    • +

  • _content_type (str, Optional) – force content-type for the request.

    • +

  • _headers (dict, optional) – set to override the headers for a single +request; this effectively ignores the headers +in the spec for a single request.

    • +

  • _host_index (int, optional) – set to override the host_index for a single +request; this effectively ignores the host_index +in the spec for a single request.

    • +
+
+
Returns:
+

Returns the result object.

+
+
+
+ +
+ +
+
+class pulumi_esc_sdk.EscClient(configuration: Configuration)
+

EscClient is a client for the ESC API. +It wraps the raw API client and provides a more convenient interface.

+
+
Parameters:
+

configuration – API client configuration.

+
+
+

Constructor

+
+
+check_environment(org_name: str, env: EnvironmentDefinition) → CheckEnvironment
+

Check an environment using the environment definition.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • env – The environment definition.

    • +
+
+
Returns:
+

The check environment result with diagnostics.

+
+
+
+ +
+
+check_environment_yaml(org_name: str, yaml_body: str) → CheckEnvironment
+

Check an environment using the YAML body.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • yaml_body – The YAML text.

    • +
+
+
Returns:
+

The check environment result with diagnostics.

+
+
+
+ +
+
+clone_environment(org_name: str, src_project_name: str, src_env_name: str, dest_project_name: str, dest_env_name: str, clone_options: dict = {}) → Environment
+

Clone an environment.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • src_project_name – The name of the source project.

    • +

  • src_env_name – The name of the source environment.

    • +

  • dest_project_name – The name of the destination project.

    • +

  • dest_env_name – The name of the destination environment.

    • +

  • clone_options – A dictionary containing clone options.

    • +
+
+
Key bool preserve_access:
+

Whether to preserve team access.

+
+
Key bool preserve_environment_tags:
+

Whether to preserve tags.

+
+
Key bool preserve_history:
+

Whether to preserve history.

+
+
Key bool preserve_revision_tags:
+

Whether to preserve version tags.

+
+
Returns:
+

The created environment.

+
+
+
+ +
+
+create_environment(org_name: str, project_name: str, env_name: str) → Environment
+

Create an environment.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
Returns:
+

The created environment.

+
+
+
+ +
+
+create_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str, revision: int) → None
+

Create an environment revision tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +

  • revision – The revision to tag.

    • +
+
+
+
+ +
+
+create_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str, tag_value: str) → EnvironmentTag
+

Create an environment tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +

  • tag_value – The value of the tag.

    • +
+
+
Returns:
+

The created environment tag.

+
+
+
+ +
+
+decrypt_environment(org_name: str, project_name: str, env_name: str) → tuple[pulumi_esc_sdk.models.environment_definition.EnvironmentDefinition, str]
+

Decrypt an environment.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
Returns:
+

The decrypted environment and the raw data.

+
+
+
+ +
+
+delete_environment(org_name: str, project_name: str, env_name: str) → None
+

Delete an environment.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
+
+ +
+
+delete_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str) → None
+

Delete an environment revision tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +
+
+
+
+ +
+
+delete_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str) → None
+

Delete an environment tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +
+
+
+
+ +
+
+get_environment(org_name: str, project_name: str, env_name: str) → tuple[pulumi_esc_sdk.models.environment_definition.EnvironmentDefinition, bytes]
+

Get an environment by name.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
Returns:
+

The environment definition and the raw data.

+
+
+
+ +
+
+get_environment_at_version(org_name: str, project_name: str, env_name: str, version: str) → tuple[pulumi_esc_sdk.models.environment_definition.EnvironmentDefinition, bytes]
+

Get an environment by name and version.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • version – The version of the environment.

    • +
+
+
Returns:
+

The environment definition and the raw data.

+
+
+
+ +
+
+get_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str) → EnvironmentRevisionTag
+

Get an environment revision tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +
+
+
Returns:
+

The environment revision tag.

+
+
+
+ +
+
+get_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str) → EnvironmentTag
+

Get an environment tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +
+
+
Returns:
+

The environment tag.

+
+
+
+ +
+
+list_environment_revision_tags(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None) → EnvironmentRevisionTags
+

List environment revision tags.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • after – The tag after which to list.

    • +

  • count – The number of tags to list.

    • +
+
+
+
+ +
+
+list_environment_revisions(org_name: str, project_name: str, env_name: str, before: int | None = None, count: int | None = None) → List[EnvironmentRevision]
+

List environment revisions, from newest to oldest.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • before – The revision before which to list.

    • +

  • count – The number of revisions to list.

    • +
+
+
+
+ +
+
+list_environment_tags(org_name: str, project_name: str, env_name: str, after: str | None = None, count: int | None = None) → ListEnvironmentTags
+

List environment tags.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • after – The tag after which to list.

    • +

  • count – The number of tags to list.

    • +
+
+
Returns:
+

The environment tags.

+
+
+
+ +
+
+list_environments(org_name: str, continuation_token: str = None) → OrgEnvironments
+

List all environments in an organization.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • continuation_token – The continuation token to use for pagination.

    • +
+
+
Returns:
+

The list of environments.

+
+
+
+ +
+
+open_and_read_environment(org_name: str, project_name: str, env_name: str) → tuple[pulumi_esc_sdk.models.environment.Environment, typing.Mapping[str, <built-in function any>], str]
+

Open and read an environment and resolves config and data.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
Returns:
+

The environment, the values, and the raw data.

+
+
+
+ +
+
+open_and_read_environment_at_version(org_name: str, project_name: str, env_name: str, version: str) → tuple[pulumi_esc_sdk.models.environment.Environment, typing.Mapping[str, <built-in function any>], str]
+

Open and read an environment at a specific version and resolves config and data.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • version – The version of the environment.

    • +
+
+
Returns:
+

The environment, the values, and the raw data.

+
+
+
+ +
+
+open_environment(org_name: str, project_name: str, env_name: str) → OpenEnvironment
+

Open an environment for reading.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +
+
+
Returns:
+

The opened environment.

+
+
+
+ +
+
+open_environment_at_version(org_name: str, project_name: str, env_name: str, version: str) → OpenEnvironment
+

Open an environment for reading at a specific version.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • version – The version of the environment.

    • +
+
+
Returns:
+

The opened environment.

+
+
+
+ +
+
+read_open_environment(org_name: str, project_name: str, env_name: str, open_session_id: str) → tuple[pulumi_esc_sdk.models.environment.Environment, Mapping[str, Any], str]
+

Read an open environment and resolves config and data.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • open_session_id – The open session identifier.

    • +
+
+
Returns:
+

The environment, the values, and the raw data.

+
+
+
+ +
+
+read_open_environment_property(org_name: str, project_name: str, env_name: str, open_session_id: str, property_name: str) → tuple[pulumi_esc_sdk.models.value.Value, Any]
+

Read a property from an open environment and resolves the value.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • open_session_id – The open session identifier.

    • +

  • property_name – The property name.

    • +
+
+
Returns:
+

The property value and the resolved value.

+
+
+
+ +
+
+update_environment(org_name: str, project_name: str, env_name: str, env: EnvironmentDefinition) → Environment
+

Update an environment using the environment definition.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • env – The environment definition.

    • +
+
+
Returns:
+

The updated environment.

+
+
+
+ +
+
+update_environment_revision_tag(org_name: str, project_name: str, env_name: str, tag_name: str, revision: int) → None
+

Update an environment revision tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +

  • revision – The revision to tag.

    • +
+
+
+
+ +
+
+update_environment_tag(org_name: str, project_name: str, env_name: str, tag_name: str, current_tag_value: str, new_tag_name: str, new_tag_value: str) → EnvironmentTag
+

Update an environment tag.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • tag_name – The name of the tag.

    • +

  • current_tag_value – The current value of the tag.

    • +

  • new_tag_name – The new name of the tag.

    • +

  • new_tag_value – The new value of the tag.

    • +
+
+
Returns:
+

The updated environment tag.

+
+
+
+ +
+
+update_environment_yaml(org_name: str, project_name: str, env_name: str, yaml_body: str) → EnvironmentDiagnostics
+

Update an environment using the YAML body.

+
+
Parameters:
+
    +

  • org_name – The name of the organization.

    • +

  • project_name – The name of the project.

    • +

  • env_name – The name of the environment.

    • +

  • yaml_body – The YAML text.

    • +
+
+
Returns:
+

The environment diagnostics.

+
+
+
+ +
+ +
+
+class pulumi_esc_sdk.EvaluatedExecutionContext(*, properties: Dict[str, Value] | None = None, schema: Any | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of EvaluatedExecutionContext from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of EvaluatedExecutionContext from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Expr(*, range: Range | None = None, base: Expr | None = None, schema: Any | None = None, keyRanges: Dict[str, Range] | None = None, literal: Any | None = None, interpolate: List[Interpolation] | None = None, symbol: List[PropertyAccessor] | None = None, access: List[Access] | None = None, list: List[Expr] | None = None, object: Dict[str, Expr] | None = None, builtin: ExprBuiltin | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Expr from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Expr from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.ExprBuiltin(*, name: str, nameRange: Range | None = None, argSchema: Any | None = None, arg: Expr | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of ExprBuiltin from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of ExprBuiltin from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Interpolation(*, text: str | None = None, value: List[PropertyAccessor] | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Interpolation from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Interpolation from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.ListEnvironmentTags(*, tags: Dict[str, EnvironmentTag], nextToken: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of ListEnvironmentTags from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of ListEnvironmentTags from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+exception pulumi_esc_sdk.OpenApiException
+

The base exception class for all OpenAPIExceptions

+
+ +
+
+class pulumi_esc_sdk.OpenEnvironment(*, id: str, diagnostics: EnvironmentDiagnostics | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of OpenEnvironment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of OpenEnvironment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.OrgEnvironment(*, organization: str | None = None, project: str, name: str, created: str, modified: str, additional_properties: Dict[str, Any] = {})
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of OrgEnvironment from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of OrgEnvironment from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +

  • Fields in self.additional_properties are added to the output dict.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.OrgEnvironments(*, environments: List[OrgEnvironment] | None = None, nextToken: str | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of OrgEnvironments from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of OrgEnvironments from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Pos(*, line: int, column: int, byte: int)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Pos from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Pos from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.PropertyAccessor(*, index: int | None = None, key: str, range: Range, value: Range | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of PropertyAccessor from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of PropertyAccessor from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Range(*, environment: str, begin: Pos, end: Pos)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Range from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Range from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Reference(*, ref: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Reference from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Reference from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Trace(*, var_def: Range | None = None, base: Value | None = None)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Trace from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Trace from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.UpdateEnvironmentRevisionTag(*, revision: int)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of UpdateEnvironmentRevisionTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of UpdateEnvironmentRevisionTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.UpdateEnvironmentTag(*, currentTag: UpdateEnvironmentTagCurrentTag, newTag: UpdateEnvironmentTagNewTag)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of UpdateEnvironmentTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of UpdateEnvironmentTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.UpdateEnvironmentTagCurrentTag(*, value: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of UpdateEnvironmentTagCurrentTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of UpdateEnvironmentTagCurrentTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.UpdateEnvironmentTagNewTag(*, name: str, value: str)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of UpdateEnvironmentTagNewTag from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of UpdateEnvironmentTagNewTag from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+
+class pulumi_esc_sdk.Value(*, value: Any | None, secret: bool | None = None, unknown: bool | None = None, trace: Trace)
+

Create a new model by parsing and validating input data from keyword arguments.

+

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be +validated to form a valid model.

+

self is explicitly positional-only to allow self as a field name.

+
+
+classmethod from_dict(obj: Dict[str, Any] | None) → Self | None
+

Create an instance of Value from a dict

+
+ +
+
+classmethod from_json(json_str: str) → Self | None
+

Create an instance of Value from a JSON string

+
+ +
+
+model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}
+

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

+
+ +
+
+to_dict() → Dict[str, Any]
+

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic’s +self.model_dump(by_alias=True):

+
    +

  • None is only added to the output dict for nullable fields that +were set at model initialization. Other fields with value None +are ignored.

    • +
+
+ +
+
+to_json() → str
+

Returns the JSON representation of the model using alias

+
+ +
+
+to_str() → str
+

Returns the string representation of the model using alias

+
+ +
+ +
+ + +
+