Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
meraki.organizations.getActionBatches
Explore with Pulumi AI
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>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]func LookupActionBatches(ctx *Context, args *LookupActionBatchesArgs, opts ...InvokeOption) (*LookupActionBatchesResult, error)
func LookupActionBatchesOutput(ctx *Context, args *LookupActionBatchesOutputArgs, opts ...InvokeOption) LookupActionBatchesResultOutput> 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)
}public static CompletableFuture<GetActionBatchesResult> getActionBatches(GetActionBatchesArgs args, InvokeOptions options)
public static Output<GetActionBatchesResult> getActionBatches(GetActionBatchesArgs args, InvokeOptions options)
fn::invoke:
  function: meraki:organizations/getActionBatches:getActionBatches
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ActionBatch stringId 
- 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.
- ActionBatch stringId 
- 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.
- actionBatch StringId 
- 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.
- actionBatch stringId 
- 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_ strid 
- 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.
- actionBatch StringId 
- 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
GetAction Batches Item 
- Items
List<GetAction Batches Item> 
- Array of ResponseOrganizationsGetOrganizationActionBatches
- ActionBatch stringId 
- 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
GetAction Batches Item 
- Items
[]GetAction Batches Item 
- Array of ResponseOrganizationsGetOrganizationActionBatches
- ActionBatch stringId 
- 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
GetAction Batches Item 
- items
List<GetAction Batches Item> 
- Array of ResponseOrganizationsGetOrganizationActionBatches
- actionBatch StringId 
- 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
GetAction Batches Item 
- items
GetAction Batches Item[] 
- Array of ResponseOrganizationsGetOrganizationActionBatches
- actionBatch stringId 
- 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
GetAction Batches Item 
- items
Sequence[GetAction Batches Item] 
- Array of ResponseOrganizationsGetOrganizationActionBatches
- action_batch_ strid 
- 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
- actionBatch StringId 
- 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
List<GetAction Batches Item Action> 
- A set of changes made as part of this action (\n\nmore details\n\n)
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Id string
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- OrganizationId string
- ID of the organization this action batch belongs to
- Status
GetAction Batches Item Status 
- Status of action batch
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- Actions
[]GetAction Batches Item Action 
- A set of changes made as part of this action (\n\nmore details\n\n)
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Id string
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- OrganizationId string
- ID of the organization this action batch belongs to
- Status
GetAction Batches Item Status 
- Status of action batch
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- actions
List<GetAction Batches Item Action> 
- A set of changes made as part of this action (\n\nmore details\n\n)
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- id String
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- organizationId String
- ID of the organization this action batch belongs to
- status
GetAction Batches Item Status 
- Status of action batch
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
- actions
GetAction Batches Item Action[] 
- A set of changes made as part of this action (\n\nmore details\n\n)
- confirmed boolean
- Flag describing whether the action should be previewed before executing or not
- id string
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- organizationId string
- ID of the organization this action batch belongs to
- status
GetAction Batches Item Status 
- Status of action batch
- synchronous boolean
- Flag describing whether actions should run synchronously or asynchronously
- actions
Sequence[GetAction Batches Item Action] 
- A set of changes made as part of this action (\n\nmore details\n\n)
- confirmed bool
- Flag describing whether the action should be previewed before executing or not
- id str
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- organization_id str
- ID of the organization this action batch belongs to
- status
GetAction Batches Item Status 
- Status of action batch
- synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- actions List<Property Map>
- A set of changes made as part of this action (\n\nmore details\n\n)
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- id String
- ID of the action batch. Can be used to check the status of the action batch at /organizations/{organizationId}/actionBatches/{actionBatchId}
- organizationId String
- ID of the organization this action batch belongs to
- status Property Map
- Status of action batch
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
GetActionBatchesItemAction    
GetActionBatchesItemStatus    
- Completed bool
- Flag describing whether all actions in the action batch have completed
- CreatedResources List<GetAction Batches Item Status Created Resource> 
- Resources created as a result of this action batch
- Errors List<string>
- List of errors encountered when running actions in the action batch
- Failed bool
- Flag describing whether any actions in the action batch failed
- Completed bool
- Flag describing whether all actions in the action batch have completed
- CreatedResources []GetAction Batches Item Status Created Resource 
- Resources created as a result of this action batch
- Errors []string
- List of errors encountered when running actions in the action batch
- Failed bool
- Flag describing whether any actions in the action batch failed
- completed Boolean
- Flag describing whether all actions in the action batch have completed
- createdResources List<GetAction Batches Item Status Created Resource> 
- Resources created as a result of this action batch
- errors List<String>
- List of errors encountered when running actions in the action batch
- failed Boolean
- Flag describing whether any actions in the action batch failed
- completed boolean
- Flag describing whether all actions in the action batch have completed
- createdResources GetAction Batches Item Status Created Resource[] 
- Resources created as a result of this action batch
- errors string[]
- List of errors encountered when running actions in the action batch
- failed boolean
- Flag describing whether any actions in the action batch failed
- completed bool
- Flag describing whether all actions in the action batch have completed
- created_resources Sequence[GetAction Batches Item Status Created Resource] 
- Resources created as a result of this action batch
- errors Sequence[str]
- List of errors encountered when running actions in the action batch
- failed bool
- Flag describing whether any actions in the action batch failed
- completed Boolean
- Flag describing whether all actions in the action batch have completed
- createdResources List<Property Map>
- Resources created as a result of this action batch
- errors List<String>
- List of errors encountered when running actions in the action batch
- failed Boolean
- Flag describing whether any actions in the action batch failed
GetActionBatchesItemStatusCreatedResource      
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the merakiTerraform Provider.
