Skip to content

UpdateScopeInput

Source code in docs_src/capo_network_security_manager/types/update_scope_input.py
class UpdateScopeInput(TypedDict, closed=True):
    scope_identifier: (
        "capo_network_security_manager.types.scope_identifier.ScopeIdentifier"
    )
    """<p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>"""
    update_token: "capo_network_security_manager.types.update_token.UpdateToken"
    """<p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>"""
    scope_description: NotRequired[
        "capo_network_security_manager.types.description.Description"
    ]
    """<p>A description of the scope.</p>"""
    scope_configuration: NotRequired[
        "capo_network_security_manager.types.scope_configuration.ScopeConfiguration"
    ]
    """<p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p> <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>"""
    is_published: "capo_network_security_manager.types.is_published.IsPublished"
    """<p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>).</p>"""
    client_token: NotRequired[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>"""

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

is_published instance-attribute

is_published: IsPublished

Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).

scope_configuration instance-attribute

scope_configuration: NotRequired[ScopeConfiguration]

The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.

A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.

scope_description instance-attribute

scope_description: NotRequired[Description]

A description of the scope.

scope_identifier instance-attribute

scope_identifier: ScopeIdentifier

The identifier of the scope. This is the scope's Amazon Resource Name (ARN).

update_token instance-attribute

update_token: UpdateToken

A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.