1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. organizations
  5. getActionBatches
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.organizations.getActionBatches

Explore with Pulumi AI

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

Example Usage

Using getActionBatches

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getActionBatches(args: GetActionBatchesArgs, opts?: InvokeOptions): Promise<GetActionBatchesResult>
function getActionBatchesOutput(args: GetActionBatchesOutputArgs, opts?: InvokeOptions): Output<GetActionBatchesResult>
Copy
def get_action_batches(action_batch_id: Optional[str] = None,
                       organization_id: Optional[str] = None,
                       status: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetActionBatchesResult
def get_action_batches_output(action_batch_id: Optional[pulumi.Input[str]] = None,
                       organization_id: Optional[pulumi.Input[str]] = None,
                       status: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetActionBatchesResult]
Copy
func LookupActionBatches(ctx *Context, args *LookupActionBatchesArgs, opts ...InvokeOption) (*LookupActionBatchesResult, error)
func LookupActionBatchesOutput(ctx *Context, args *LookupActionBatchesOutputArgs, opts ...InvokeOption) LookupActionBatchesResultOutput
Copy

> Note: This function is named LookupActionBatches in the Go SDK.

public static class GetActionBatches 
{
    public static Task<GetActionBatchesResult> InvokeAsync(GetActionBatchesArgs args, InvokeOptions? opts = null)
    public static Output<GetActionBatchesResult> Invoke(GetActionBatchesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetActionBatchesResult> getActionBatches(GetActionBatchesArgs args, InvokeOptions options)
public static Output<GetActionBatchesResult> getActionBatches(GetActionBatchesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: meraki:organizations/getActionBatches:getActionBatches
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ActionBatchId string
actionBatchId path parameter. Action batch ID
OrganizationId string
organizationId path parameter. Organization ID
Status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
ActionBatchId string
actionBatchId path parameter. Action batch ID
OrganizationId string
organizationId path parameter. Organization ID
Status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
actionBatchId String
actionBatchId path parameter. Action batch ID
organizationId String
organizationId path parameter. Organization ID
status String
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
actionBatchId string
actionBatchId path parameter. Action batch ID
organizationId string
organizationId path parameter. Organization ID
status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
action_batch_id str
actionBatchId path parameter. Action batch ID
organization_id str
organizationId path parameter. Organization ID
status str
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
actionBatchId String
actionBatchId path parameter. Action batch ID
organizationId String
organizationId path parameter. Organization ID
status String
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.

getActionBatches Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Item GetActionBatchesItem
Items List<GetActionBatchesItem>
Array of ResponseOrganizationsGetOrganizationActionBatches
ActionBatchId string
actionBatchId path parameter. Action batch ID
OrganizationId string
organizationId path parameter. Organization ID
Status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
Id string
The provider-assigned unique ID for this managed resource.
Item GetActionBatchesItem
Items []GetActionBatchesItem
Array of ResponseOrganizationsGetOrganizationActionBatches
ActionBatchId string
actionBatchId path parameter. Action batch ID
OrganizationId string
organizationId path parameter. Organization ID
Status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
id String
The provider-assigned unique ID for this managed resource.
item GetActionBatchesItem
items List<GetActionBatchesItem>
Array of ResponseOrganizationsGetOrganizationActionBatches
actionBatchId String
actionBatchId path parameter. Action batch ID
organizationId String
organizationId path parameter. Organization ID
status String
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
id string
The provider-assigned unique ID for this managed resource.
item GetActionBatchesItem
items GetActionBatchesItem[]
Array of ResponseOrganizationsGetOrganizationActionBatches
actionBatchId string
actionBatchId path parameter. Action batch ID
organizationId string
organizationId path parameter. Organization ID
status string
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
id str
The provider-assigned unique ID for this managed resource.
item GetActionBatchesItem
items Sequence[GetActionBatchesItem]
Array of ResponseOrganizationsGetOrganizationActionBatches
action_batch_id str
actionBatchId path parameter. Action batch ID
organization_id str
organizationId path parameter. Organization ID
status str
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.
id String
The provider-assigned unique ID for this managed resource.
item Property Map
items List<Property Map>
Array of ResponseOrganizationsGetOrganizationActionBatches
actionBatchId String
actionBatchId path parameter. Action batch ID
organizationId String
organizationId path parameter. Organization ID
status String
status query parameter. Filter batches by status. Valid types are pending, completed, and failed.

Supporting Types

GetActionBatchesItem

Actions This property is required. List<GetActionBatchesItemAction>
A set of changes made as part of this action (\n\nmore details\n\n)
Confirmed This property is required. bool
Flag describing whether the action should be previewed before executing or not
Id This property is required. string
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
OrganizationId This property is required. string
ID of the organization this action batch belongs to
Status This property is required. GetActionBatchesItemStatus
Status of action batch
Synchronous This property is required. bool
Flag describing whether actions should run synchronously or asynchronously
Actions This property is required. []GetActionBatchesItemAction
A set of changes made as part of this action (\n\nmore details\n\n)
Confirmed This property is required. bool
Flag describing whether the action should be previewed before executing or not
Id This property is required. string
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
OrganizationId This property is required. string
ID of the organization this action batch belongs to
Status This property is required. GetActionBatchesItemStatus
Status of action batch
Synchronous This property is required. bool
Flag describing whether actions should run synchronously or asynchronously
actions This property is required. List<GetActionBatchesItemAction>
A set of changes made as part of this action (\n\nmore details\n\n)
confirmed This property is required. Boolean
Flag describing whether the action should be previewed before executing or not
id This property is required. String
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
organizationId This property is required. String
ID of the organization this action batch belongs to
status This property is required. GetActionBatchesItemStatus
Status of action batch
synchronous This property is required. Boolean
Flag describing whether actions should run synchronously or asynchronously
actions This property is required. GetActionBatchesItemAction[]
A set of changes made as part of this action (\n\nmore details\n\n)
confirmed This property is required. boolean
Flag describing whether the action should be previewed before executing or not
id This property is required. string
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
organizationId This property is required. string
ID of the organization this action batch belongs to
status This property is required. GetActionBatchesItemStatus
Status of action batch
synchronous This property is required. boolean
Flag describing whether actions should run synchronously or asynchronously
actions This property is required. Sequence[GetActionBatchesItemAction]
A set of changes made as part of this action (\n\nmore details\n\n)
confirmed This property is required. bool
Flag describing whether the action should be previewed before executing or not
id This property is required. str
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
organization_id This property is required. str
ID of the organization this action batch belongs to
status This property is required. GetActionBatchesItemStatus
Status of action batch
synchronous This property is required. bool
Flag describing whether actions should run synchronously or asynchronously
actions This property is required. List<Property Map>
A set of changes made as part of this action (\n\nmore details\n\n)
confirmed This property is required. Boolean
Flag describing whether the action should be previewed before executing or not
id This property is required. String
ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
organizationId This property is required. String
ID of the organization this action batch belongs to
status This property is required. Property Map
Status of action batch
synchronous This property is required. Boolean
Flag describing whether actions should run synchronously or asynchronously

GetActionBatchesItemAction

Body This property is required. string
Data provided in the body of the Action. Contents depend on the Action type
Operation This property is required. string
The operation to be used by this action
Resource This property is required. string
Unique identifier for the resource to be acted on
Body This property is required. string
Data provided in the body of the Action. Contents depend on the Action type
Operation This property is required. string
The operation to be used by this action
Resource This property is required. string
Unique identifier for the resource to be acted on
body This property is required. String
Data provided in the body of the Action. Contents depend on the Action type
operation This property is required. String
The operation to be used by this action
resource This property is required. String
Unique identifier for the resource to be acted on
body This property is required. string
Data provided in the body of the Action. Contents depend on the Action type
operation This property is required. string
The operation to be used by this action
resource This property is required. string
Unique identifier for the resource to be acted on
body This property is required. str
Data provided in the body of the Action. Contents depend on the Action type
operation This property is required. str
The operation to be used by this action
resource This property is required. str
Unique identifier for the resource to be acted on
body This property is required. String
Data provided in the body of the Action. Contents depend on the Action type
operation This property is required. String
The operation to be used by this action
resource This property is required. String
Unique identifier for the resource to be acted on

GetActionBatchesItemStatus

Completed This property is required. bool
Flag describing whether all actions in the action batch have completed
CreatedResources This property is required. List<GetActionBatchesItemStatusCreatedResource>
Resources created as a result of this action batch
Errors This property is required. List<string>
List of errors encountered when running actions in the action batch
Failed This property is required. bool
Flag describing whether any actions in the action batch failed
Completed This property is required. bool
Flag describing whether all actions in the action batch have completed
CreatedResources This property is required. []GetActionBatchesItemStatusCreatedResource
Resources created as a result of this action batch
Errors This property is required. []string
List of errors encountered when running actions in the action batch
Failed This property is required. bool
Flag describing whether any actions in the action batch failed
completed This property is required. Boolean
Flag describing whether all actions in the action batch have completed
createdResources This property is required. List<GetActionBatchesItemStatusCreatedResource>
Resources created as a result of this action batch
errors This property is required. List<String>
List of errors encountered when running actions in the action batch
failed This property is required. Boolean
Flag describing whether any actions in the action batch failed
completed This property is required. boolean
Flag describing whether all actions in the action batch have completed
createdResources This property is required. GetActionBatchesItemStatusCreatedResource[]
Resources created as a result of this action batch
errors This property is required. string[]
List of errors encountered when running actions in the action batch
failed This property is required. boolean
Flag describing whether any actions in the action batch failed
completed This property is required. bool
Flag describing whether all actions in the action batch have completed
created_resources This property is required. Sequence[GetActionBatchesItemStatusCreatedResource]
Resources created as a result of this action batch
errors This property is required. Sequence[str]
List of errors encountered when running actions in the action batch
failed This property is required. bool
Flag describing whether any actions in the action batch failed
completed This property is required. Boolean
Flag describing whether all actions in the action batch have completed
createdResources This property is required. List<Property Map>
Resources created as a result of this action batch
errors This property is required. List<String>
List of errors encountered when running actions in the action batch
failed This property is required. Boolean
Flag describing whether any actions in the action batch failed

GetActionBatchesItemStatusCreatedResource

Id This property is required. string
ID of the created resource
Uri This property is required. string
URI, not including base, of the created resource
Id This property is required. string
ID of the created resource
Uri This property is required. string
URI, not including base, of the created resource
id This property is required. String
ID of the created resource
uri This property is required. String
URI, not including base, of the created resource
id This property is required. string
ID of the created resource
uri This property is required. string
URI, not including base, of the created resource
id This property is required. str
ID of the created resource
uri This property is required. str
URI, not including base, of the created resource
id This property is required. String
ID of the created resource
uri This property is required. String
URI, not including base, of the created resource

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi