1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getActionBatches
Cisco Meraki v0.2.9 published on Tuesday, Jul 16, 2024 by Pulumi

meraki.organizations.getActionBatches

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.9 published on Tuesday, Jul 16, 2024 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>
    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getActionBatches:getActionBatches
      arguments:
        # arguments dictionary

    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 List<GetActionBatchesItemAction>
    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 GetActionBatchesItemStatus
    Status of action batch
    Synchronous bool
    Flag describing whether actions should run synchronously or asynchronously
    Actions []GetActionBatchesItemAction
    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 GetActionBatchesItemStatus
    Status of action batch
    Synchronous bool
    Flag describing whether actions should run synchronously or asynchronously
    actions List<GetActionBatchesItemAction>
    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 GetActionBatchesItemStatus
    Status of action batch
    synchronous Boolean
    Flag describing whether actions should run synchronously or asynchronously
    actions GetActionBatchesItemAction[]
    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 GetActionBatchesItemStatus
    Status of action batch
    synchronous boolean
    Flag describing whether actions should run synchronously or asynchronously
    actions Sequence[GetActionBatchesItemAction]
    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 GetActionBatchesItemStatus
    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

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

    GetActionBatchesItemStatus

    Completed bool
    Flag describing whether all actions in the action batch have completed
    CreatedResources List<GetActionBatchesItemStatusCreatedResource>
    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 []GetActionBatchesItemStatusCreatedResource
    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<GetActionBatchesItemStatusCreatedResource>
    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 GetActionBatchesItemStatusCreatedResource[]
    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[GetActionBatchesItemStatusCreatedResource]
    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

    Id string
    ID of the created resource
    Uri string
    URI, not including base, of the created resource
    Id string
    ID of the created resource
    Uri string
    URI, not including base, of the created resource
    id String
    ID of the created resource
    uri String
    URI, not including base, of the created resource
    id string
    ID of the created resource
    uri string
    URI, not including base, of the created resource
    id str
    ID of the created resource
    uri str
    URI, not including base, of the created resource
    id String
    ID of the created resource
    uri 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.
    meraki logo
    Cisco Meraki v0.2.9 published on Tuesday, Jul 16, 2024 by Pulumi