---
title: SamplerOptions (latest version)
description: API reference for qiskit_ibm_runtime.options.SamplerOptions in the latest version of qiskit-ibm-runtime
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit-ibm-runtime/options-sampler-options
---

# SamplerOptions

*class* `SamplerOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_shots=Unset, dynamical_decoupling=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)`

[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.49/qiskit_ibm_runtime/options/sampler_options.py#L24-L55)

Bases: `OptionsV2`

Options for V2 Sampler.

## Attributes

**Parameters**

- **\_VERSION** (*int*)
- **max\_execution\_time** (*UnsetType | int*)
- **environment** ([*EnvironmentOptions*](/docs/api/qiskit-ibm-runtime/options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
- **simulator** ([*SimulatorOptions*](/docs/api/qiskit-ibm-runtime/options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
- **default\_shots** (*UnsetType | int*)
- **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](/docs/api/qiskit-ibm-runtime/options-dynamical-decoupling-options "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*)
- **execution** ([*SamplerExecutionOptionsV2*](/docs/api/qiskit-ibm-runtime/options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.sampler_execution_options.SamplerExecutionOptionsV2") *| Dict*)
- **twirling** ([*TwirlingOptions*](/docs/api/qiskit-ibm-runtime/options-twirling-options "qiskit_ibm_runtime.options.twirling_options.TwirlingOptions") *| Dict*)
- **experimental** (*UnsetType | dict*)

### default\_shots

Type: `UnsetType` | `int`

Default value: `Unset`

The default number of shots to use if none are specified in the PUBs or in the run method.

Default: 4096.

### dynamical\_decoupling

Type: [`DynamicalDecouplingOptions`](/docs/api/qiskit-ibm-runtime/options-dynamical-decoupling-options "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") | `Dict`

Default value: `FieldInfo(annotation=NoneType, required=False, default_factory=DynamicalDecouplingOptions)`

Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](/docs/api/qiskit-ibm-runtime/options-dynamical-decoupling-options "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options.

### environment

Type: [`EnvironmentOptions`](/docs/api/qiskit-ibm-runtime/options-environment-options "qiskit_ibm_runtime.options.EnvironmentOptions") | `Dict`

Default value: `FieldInfo(annotation=NoneType, required=False, default_factory=EnvironmentOptions)`

### execution

Type: [`SamplerExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.sampler_execution_options.SamplerExecutionOptionsV2") | `Dict`

Default value: `FieldInfo(annotation=NoneType, required=False, default_factory=SamplerExecutionOptionsV2)`

Execution time options.

See [`SamplerExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") for all available options.

### experimental

Type: `UnsetType` | `dict`

Default value: `Unset`

Experimental options.

### max\_execution\_time

Type: `UnsetType` | `int`

Default value: `Unset`

### simulator

Type: [`SimulatorOptions`](/docs/api/qiskit-ibm-runtime/options-simulator-options "qiskit_ibm_runtime.options.SimulatorOptions") | `Dict`

Default value: `FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)`

### twirling

Type: [`TwirlingOptions`](/docs/api/qiskit-ibm-runtime/options-twirling-options "qiskit_ibm_runtime.options.twirling_options.TwirlingOptions") | `Dict`

Default value: `FieldInfo(annotation=NoneType, required=False, default_factory=TwirlingOptions)`

Pauli twirling options.

See [`TwirlingOptions`](/docs/api/qiskit-ibm-runtime/options-twirling-options "qiskit_ibm_runtime.options.TwirlingOptions") for all available options.

## Methods

### update

`update(**kwargs)`

[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.49/qiskit_ibm_runtime/options/options.py#L147-L156)

Update the options.

**Parameters**

**kwargs** (*Any*)

**Return type**

None
