Skip to content

list_network_migration_mapper_segments

list_network_migration_mapper_segments(
    network_migration_execution_id: NetworkMigrationExecutionID,
    network_migration_definition_id: NetworkMigrationDefinitionID,
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    filters: Optional[ListNetworkMigrationMapperSegmentsFilters] = None,
    max_results: Optional[MaxResultsType] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListNetworkMigrationMapperSegmentsResponse

Lists mapper segments, which represent logical groupings of network resources to be migrated together.

Parameters:

Raises:

Examples:

Sample ListNetworkMigrationMapperSegments call

>>> client.list_network_migration_mapper_segments(network_migration_execution_id='01234567-abcd-abcd-abcd-0123456789ab', network_migration_definition_id='nmd-01234567891234567')
Source code in docs_src/capo_mgn/_services/mgn.py
def list_network_migration_mapper_segments(
    self,
    network_migration_execution_id: "capo_mgn.types.network_migration_execution_id.NetworkMigrationExecutionID",
    network_migration_definition_id: "capo_mgn.types.network_migration_definition_id.NetworkMigrationDefinitionID",
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    filters: Optional[
        "capo_mgn.types.list_network_migration_mapper_segments_filters.ListNetworkMigrationMapperSegmentsFilters"
    ] = None,
    max_results: Optional["capo_mgn.types.max_results_type.MaxResultsType"] = None,
    next_token: Optional["capo_mgn.types.pagination_token.PaginationToken"] = None,
) -> "capo_mgn.types.list_network_migration_mapper_segments_response.ListNetworkMigrationMapperSegmentsResponse":
    """<p>Lists mapper segments, which represent logical groupings of network resources to be migrated together.</p>

    Args:
        network_migration_execution_id: <p>The unique identifier of the network migration execution.</p>
        network_migration_definition_id: <p>The unique identifier of the network migration definition.</p>
        filters: <p>Filters to apply when listing segments.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_mgn.errors.access_denied_exception.AccessDeniedException: <p>Operation denied due to a file permission or access check error.</p>
        capo_mgn.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found exception.</p>
        capo_mgn.errors.throttling_exception.ThrottlingException: <p>Reached throttling quota exception.</p>
        capo_mgn.errors.validation_exception.ValidationException: <p>Validate exception.</p>
        capo_mgn.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample ListNetworkMigrationMapperSegments call

        >>> client.list_network_migration_mapper_segments(network_migration_execution_id='01234567-abcd-abcd-abcd-0123456789ab', network_migration_definition_id='nmd-01234567891234567')
    """

    def _handler(
        req: "OperationRequest[capo_mgn.types.list_network_migration_mapper_segments_request.ListNetworkMigrationMapperSegmentsRequest]",
    ) -> OperationResponse[
        "capo_mgn.types.list_network_migration_mapper_segments_response.ListNetworkMigrationMapperSegmentsResponse"
    ]:
        import capo_mgn._operations.application_migration_service.list_network_migration_mapper_segments

        output, http_response = (
            capo_mgn._operations.application_migration_service.list_network_migration_mapper_segments.list_network_migration_mapper_segments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mgn.types.list_network_migration_mapper_segments_response.ListNetworkMigrationMapperSegmentsResponse",
    ) -> dict[str, Any]:
        import capo_mgn.types.list_network_migration_mapper_segments_response

        return capo_mgn.types.list_network_migration_mapper_segments_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListNetworkMigrationMapperSegments", redact_output=_redact_output
        ),
    )
    input_: capo_mgn.types.list_network_migration_mapper_segments_request.ListNetworkMigrationMapperSegmentsRequest = {
        "network_migration_execution_id": network_migration_execution_id,
        "network_migration_definition_id": network_migration_definition_id,
    }
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output